C#注释 -0015

C类型注释

C#用的是传统C类型语言的注释，单行用//，多行用/*...*/

 

XML文档

除了C风格的注释外，C#还有一个非常出色的功能：根据特定的注释自动创建XML格式的文档说明。

这些注释都是单行注释，以三斜杠///开头而不是通常的双斜杠//。

在///注释中，可以把包含类型和类型成员的文档说明的XML标记放在代码中，下面是编译器能识别的标签表：

标签	描述
	将一行注释文本标记成代码格式，如int i = 10;。
	将多行注释包含在标记成代码块。
	标记一个代码例子。
	记录一个异常类(语法由编译器验证)。
	包含其他说明文档里的注释(语法由编译器验证)。
	在文档中插入一个列表。
	给出文本的结构。
	标记方法的参数(语法由编译器验证)。
	标识一个单词是否为一个方法参数(语法由编译器验证)。
	记录一个成员的可访问性(语法由编译器验证)。
	追加成员的描述。
	记录方法的返回值。
	提供另外一个参数的交叉引用(语法由编译器验证)。
	在描述里提供一个"另外参见"小节(语法由编译器验证)。
	提供一个类型或成员的简要介绍。
	描述一个泛型类型需要的类型参数。
	提供类型参数的名称。
	描述一个属性。

注意：VS Code如何想输入///后，自动添加注释结构的话，需要安装VS Code插件：vscode-docomment

 

///注释生成XML文档

• 在.csproj文件中添加:

 
    true
    bin\YourApi.XML
  

　　编译后在生成目录中可见.xml文档。