《刻意练习之C#》-0015- C#注释

C类型注释

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

 

XML文档

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

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

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

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

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

 

///注释生成XML文档

  • 在.csproj文件中添加:
 <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <DocumentationFile>bin\YourApi.XML</DocumentationFile>
  </PropertyGroup>

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

《刻意练习之C#》-0015- C#注释

上一篇:Ubuntu用户都应该了解的快捷键


下一篇:Ubuntu 终端如何分割多个窗口