如何使我的 C# dll 程序集在 Visual Studio 对象浏览器中包含注释文本？

Question

如果我在 Visual Studio 对象浏览器中打开此程序集，我发现系统 dll 包含注释文本，如下所示： 你可以看到，有评论文字。但我的程序集不包含此内容，我已为这些属性编写注释文本。 所以我想知道，如何为我的 dll 程序添加这些信息？

Answer 1

该文档是根据您在类/方法声明之前编写的XML 文档（C# 编程指南）块生成的。

上述文档的示例：

/// <summary>  
///  This class performs an important function.  
/// </summary>  
public class MyClass {}

如果您正在生成/打包程序集以供其他人使用，那么了解在项目属性（“生成”页面）中打开 XML 文档选项非常重要。

请参阅使用 XML 注释记录代码（也在 Microsoft 站点上）以获取完整的演练。