此示例演示如何向代码添加 XML 文档注释。
注释
计算机可能会在以下说明中显示某些 Visual Studio 用户界面元素的不同名称或位置。 你拥有的 Visual Studio 版本以及所使用的设置决定了这些元素。 有关更多信息,请参阅 自定义 IDE。
为类型或成员创建 XML 文档
在 代码编辑器中,将光标放在要为其创建文档的类型或成员上方的行上。
类型
'''
(三个单引号)。在 代码编辑器中添加类型或成员的 XML 主干。
在相应的标记之间添加描述性信息。
注释
如果在 XML 文档块中添加其他行,则必须以每行开头
'''
。添加其他代码以使用具有新 XML 文档注释的类型或成员。
IntelliSense 显示<summary>标签中的类型或成员的文本。
编译代码以生成包含文档注释的 XML 文件。 有关详细信息,请参阅 -doc。