Visual Studio 2010中所有注释的文档

Question

如何在Visual Studio 2010中为C＃语言创建所有类，方法和属性注释的文档？

Answer 1

尝试Sandcastle和Sandcastle Helpfile Builder。它以MSDN样式创建CHM和MSHelpfiles或HTML页面。它易于使用，可以加载Soultion Files 带有Sandcaste的Helpfile Builder：http://shfb.codeplex.com/
仅限沙堡：http://sandcastle.codeplex.com/

Answer 2

您可以使用创建类似文档的MSDN Sandcastle

Answer 3

Doxygen会根据代码中的注释生成精美的HTML文档，前提是您遵循一些简单的格式规则。

Answer 4

首先值得一提的是，您希望记录图书馆的API以便其他人（甚至您在未来日期:-)能够，这是值得称道的。使用您的代码，而无需读取您的代码。这本身就是一个很好的步骤！

有许多工具可以帮助自动执行此任务，特别是 Doxygen 和 Sandcastle ，正如其他人之前提到的那样。我没有使用Doxygen所以我会将我的评论限制在Sandcastle。由Microsoft提供的Sandcastle是一个很好的起点，但显然很难使用，因此一些有动力的独立开发人员在Sandcastle之上构建了更多可用的界面。其中最重要的一个是 Sandcastle帮助文件生成器（SHFB）。使用SHFB的GUI，您“只需”创建一个Sandcastle项目，根据自己的喜好设置项目属性，然后将您的文档集构建为网站或CHM文件或其他几种格式。

我在上面的引号中写了简单，因为在SHFB中工作是你面前任务的最小部分 - 更大的任务是使用适当和正确的文档注释来装饰你的代码（doc -comments）作为Sandcastle或其他文档引擎的“源代码”。您需要花费大量时间和精力来记录所有代码，但我相信，正如您可能已经推断的那样，它绝对值得。除了上述原因，其他人将能够更轻松地使用您的代码，我发现记录我的代码还有另一个重要的好处 - 它可以帮助我编写更好的代码。当我开始记录一个新的方法或类时，我常常对自己说“”哦，如果它被称为Y而不是X，这个参数会更清楚。“或”哎呀 - 这个方法对于其他人来说，它不够通用;我需要添加一个Z参数。“或”哈！这个类不能很好地处理这些极端情况。“换句话说，就是描述您的类或方法或参数会让您仔细考虑它，因此编写文档注释会带来更好的代码。

理论如此之多;有关Sandcastle和SHFB的一些实用建议和指南，请查看我在Simple-Talk.com上发表的题为Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code的文章。本文详细记录了我通过SHFB的研究和实验发现的所有事情。随附本文是一个方便的wallchart，它汇集了您可能在doc-comments中使用的所有文档和未记录的元素和属性。这是一个挂图的片段，以激发你的胃口：