如何在Visual Studio中获取文档

Question

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

Answer 1

编辑：见this answer

---

在解决方案资源管理器中右键单击项目节点，然后选择“属性”（或按Alt-Enter键）。

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

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

文档注释会自动构建到指定的xml文件中。

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

Answer 2

GhostDoc会帮助您

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

Answer 3

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