使用 XML doc 注释需要分隔符,分隔符为编译器指示文档注释的起止位置。XML 文档标记可以与以下几种分隔符一起使用:

///

这是显示在文档示例中并由 Visual C# 项目模板使用的形式。

Note注意

Visual Studio IDE 具有一项称为“智能注释编辑”的功能,它自动插入 <summary> 和 </summary> 标记,并且当您在代码编辑器中键入 /// 分隔符后将光标移动到这些标记内。从项目属性页的“选项”对话框 ->“文本编辑器”->“C#/J#”->“格式设置”可以访问此功能。

/** */

多行分隔符。

使用 /** */ 分隔符时有一些格式设置规则:

示例:

Expand image请参见