文档注释
///用于文档注释。
这种注释会在编译的时候可以自动产生XML文档，设计说明文档就可以自动产生，不用手工再去写。
1.建立源文件test.cs 如下：
///<Summary>
///一个Test类
///</Summary>
public class test
{
///<Summary>
///入口方法
///</Summary>
public static void Mial()
{
System.Console.WriteLine(“Hello,World”);
｝
}
2.对其编译
csc /t:exe /doc:test.xml text.cs
3.编译后产生的test.xml文件内容
<?xml version="1.0" ?>
- <doc>
- <assembly>
<name>test</name>
</assembly>
- <members>
- <member>
<Summary>一个Test类</Summary>
</member>
- <member>
<Summary>入口方法</Summary>
</member>
</members>
</doc>
4.部分标识符及其描述
|
标识符 |
描述及示例 |
应用于 |
|
<Summary> |
对整体进行概要性描述<summary>Description</summary> |
类、属性（不推荐）、方法等 |
|
<para> |
跟在Summary之后，对方法所涉及的入口参数进行有效的解释 <param name=“args”></param> |
方法的入口参数 |
|
<remarks> |
对一些语句进行备注性描述 <remarks>本类需要调用另外一个User类相关方法</remarks> |
类、方法、属性等 |
|
<returns> |
对方法的返回值进行解释 <returns>返回值零代表操作成功，-1代表操作不成功</returns> |
方法的返回值 |
|
<see> |
在生成的文档中产生一个连接到其它描述的超链接; <see cref=”[member]”/> |
可以在其它注释标识符中加入 |
|
<seealso> |
与上者的区别是本标识符显示超链接在一个文档的尾部的“See Also”区域，而前者在文档之中; <seealso cref=”[member]”/> |
不可以在其它注释标识符中加入 |
|
<code> |
如果需要置入一部分源代码段，可以使用本标识符将其标记出来 <code> |
可以在其它注释标识符中加入<value> |
