Visual Studio 2010中所有注释的文档[关闭]

问题描述 投票:3回答:4

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

c# visual-studio visual-studio-2010 documentation documentation-generation
4个回答
4
投票

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


4
投票

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


3
投票

Doxygen将根据您的代码中的注释生成漂亮的HTML文档,前提是您遵循一些简单的格式规则。


1
投票

首先,值得一提的是,您希望记录库的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中使用的所有文档和未记录的元素和属性。这是一个挂图的片段,以激发你的胃口:

© www.soinside.com 2019 - 2024. All rights reserved.