xml文件中注释怎么写



本文说明了 Visual Studio 如何通过自动生成标准的 XML 文档注释结构，来帮助记录类和方法等文档代码元素。 在编译时，可生成一个包含文档注释的 XML 文件。

可将由编译器生成的 XML 文件与 .NET 程序集一起分发，让 Visual Studio 和其他 IDE 能够使用 IntelliSense 快速显示类型和成员信息。 还可以通过 DocFX 和 Sandcastle 等工具运行 XML 文件，从而生成 API 参考网站。

也可以将GenerateDocumentationFile 或 DocumentationFile 属性添加到 .csproj、.vbproj 或 .fsproj 文件。 将 设置为 ，以生成具有默认名称和位置的文档文件。 使用 属性指定其他名称或位置。

如果使用 本身或将 属性设置为 ，则会生成具有指定名称和位置的文档文件。 但如果将 设置为 ，则即使设置了 属性，也不会生成任何文档文件。

在 C# 中键入 或在 Visual Basic 中键入 后，可以设置注释选项以自动插入 XML 注释结构。

1. 从 Visual Studio 菜单栏，选择“工具”>“选项”。
2. 在“选项”对话框中，导航到“文本编辑器”>“C#”（或“Visual Basic”）>“高级”。
3. 在“注释”部分下，选择或取消选择“为 \ 生成 XML 文档注释”（或“'''”）。

1. 在 Visual Studio 中，将游标放在要记录的元素上（例如，一种方法）。
2. 请执行以下一项操作：
   • 如果启用了自动注释插入快捷方式，请在 C# 中键入 或在 Visual Basic 中键入 。
   • 在“编辑”菜单上，选择“IntelliSense”>“插入注释”。
   • 在右键单击或关联菜单中，选择“片段”>“插入注释”。

   这时会立即基于代码元素生成 XML 注释结构。 例如，在注释 方法时，该模板会生成 元素，为该参数生成一个 元素，并生成一个记录返回值的 元素。

3. 为每个 XML 元素输入说明以完整记录代码。 例如：

可以在注释中使用 XML 元素和样式，从而在将鼠标悬停在代码上时在“快速信息”中呈现。 这些元素包括斜体或粗体样式、项目符号列表或编号列表，以及可点击的 或 链接。

例如，将 C# 程序文件中输入以下代码：

将鼠标悬停在 GetUserName 上时，“快速信息”窗格将显示如下：

• 文档注释
• 在 Visual Basic 中创建 XML 文档
• 注释 (C++)
• XML 文档 (Visual C++)
• 代码生成

版权声明：

本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。

本文网址：https://www.mushiming.com/mjsbk/4770.html