如何在Visual Studio 2012中创建XML文档注释

Question

我该如何在 Visual Studio 2012 中生成我的 C# web 应用程序的文档，就像 Eclipse 一样？

- soamazing

---

你尝试过什么？（在我看来，需要发布Web应用程序的XML文档有点不寻常。类库可以，但是谁会引用一个Web应用程序呢？） - Jon Skeet

@SaniHuttunen 但这并不重要，仅仅因为他是那个人就可以粗鲁吗？ - soamazing

好的@SaniHuttunen！！对不起，Jon！我认为VS2012有与Eclipse相同的工具来制作文档！！ - soamazing

Answer 1

在Visual Studio中，转到工具菜单->扩展管理器...然后在扩展管理器中点击在线画廊（在左侧），然后在右上角的搜索框中输入文本... ghostdoc 这是一个非常好的文档助手。

- Paul Zahra

Answer 2

您可以使用 XML 注释来注释您的代码

/// <summary>
///  This class performs an important function.
/// </summary>

在编译/doc后生成XML文档。

此处是源代码：http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

我还建议您使用Sandcastle及其Help File Builder，这是一个非常强大的工具： http://shfb.codeplex.com/

- Alex

---

Sandcastle现在在微软之外维护，并有一个专门关于Web项目的页面http://www.ewoodruff.us/shfbdocs/html/94c7f744-9b90-4254-93ab-9b15f47d9f42.htm。 - Stephen Kennedy

Answer 3

您可以使用 GhostDoc 进行 XML 文档编写。

http://submain.com/products/ghostdoc.aspx

你可以使用沙堡来创建帮助文档

http://sandcastle.codeplex.com/

- Raghav

Answer 4

请检查此帖：免费的Visual Studio XML文档编写工具。

他们建议使用sandcastle工具。

- J-man Venk