如何在 Visual Studio 中获取文档

Question

我有我的 .Net 项目。现在，我想为这个项目创建我的项目文档。 Visual Studio 2013 中是否有任何工具可以帮助我根据为不同的类、函数等添加的 cmets 构建文档？

Answer 1

编辑：见this answer

---

在解决方案资源管理器中右键单击您的项目节点并选择属性（或按 Alt-Enter）。

在“属性”视图中，选择左侧菜单中的Build。

在“输出”部分选择 XML 文档文件复选框（并可选择更改路径或文件名）。

文档 cmets 会自动内置到指定的 xml 文件中。

另见Recommended Tags for Documentation Comments (C# Programming Guide)

Answer 2

GhostDoc 会帮助你

GhostDoc 是一个 Visual Studio 扩展，可根据方法和属性的类型、参数、名称和其他上下文信息自动生成 XML 文档 cmets。

Answer 3

如果如上所述，您从项目构建设置中启用“XML 文档文件”输出，VS 将生成文档 XML，详细说明项目中每个类的成员。然后，您可以使用 MS SandCastle 工具将这些 XML 转换为 MSDN 样式的帮助文档和/或 HTML。除了自动生成的文档之外，您还可以将 ///XML cmets 添加到您的类和公共成员中，以提供更多信息。但是，我建议不要对代码中的文档过于着迷，而不是对类的高级概述。否则，您的 cmets 将面临与您的代码不同步的风险，尤其是在重构之后。唯一比没有 cmets 更有帮助的是代码的错误 cmets。