从C#XML生成文档评论
我最近开始了一个新的项目,我第一次使用C#。 我发现尽pipeVisual Studio有助于创buildC#的XML注释来logging类和方法,但是生成MSDN或Javadoc样式文档的工作并不多。
Google告诉我,Visual Studio 2003包含了一个生成这种文档的工具,但是它不再包含在IDE的更高版本中。
如果我希望利用我精心制作的(我向你保证!)XML标记,我有什么select?
感谢您的答案,但Sandcastle似乎有点痛苦的configuration和使用,所以我一直在寻找。 我刚刚find另一个select – Doxygen 。
Doxygen生成javadoc风格的文档,虽然它看起来主要是为了在你的评论中从自定义标记生成文档。 很显然,Doxygen也支持C#XML注释,尽pipe在他们的网站上我找不到任何提及。
无论如何,我推荐它。 它很容易使用,支持多种语言,并为您生成类图。
你可以使用沙堡来做到这一点。
它的一些资源是:沙堡:
- 沙堡
- Sandcastle帮助文件生成器 – GUI
- 用于Sandcastle的DocProject
关于loggingC#代码的文章:
- XML注释让您直接从您的Visual Studio .NET源文件构build文档 (在MSDN杂志上)
- C#文档和评论 (关于CodeProject)
- C#和XML源代码文档 (在CodeProject上)
- C#教程第19课:代码文档
我可以虚心地build议尝试ImmDoc.NET – 一个我刚刚开发并且最近在CodePlex上发布的简单项目。 它重量轻,使用非常简单,支持.NET 2.0。
@Portman:NDoc已经死了,而Sandcastle可能是下一个最好的(已经死了),Doxygen非常简单,直接使用“开箱即用”,这也是非常容易configuration的。
它也有一个graphics用户界面,帮助configuration和testing,所以你可以调整你的心中的内容。
我很高兴你find了最好的select – Doxygen! 我使用C#.NET的Doxygen,它生成类图,inheritance图等。这里是一个翔实的博客文章 。
感谢@zappan答案帮助我,我将简化每一个谁想要创build.Net文档。 我使用这个文件作为参考:
首先,您应该启用“为Visual Studio生成XML文档文件”(默认情况下,Visual Studio不会创build该文件):
右键单击项目,然后select属性窗口。 selectBuild
选项卡,最后启用XML documentation file
。 确保在这个阶段之后build立你的项目。
其次下载Sandcastle帮助文件生成器 ,通过提供一个GUI来帮助创build文档API。 注意它包含Sandcastle安装文件,所以你不需要下载Sandcastle。
现在创build一个文档很简单:
1-打开Sandcastle帮助文件生成器并创build新的项目。
2-在Project Explorer
右键单击Documentation Source
然后selectAdd Documentation Source
。
3-导航到您的dll程序集文件和XML文档文件所在的文件夹(通常在bin / debug文件夹中)。 select程序集和XML文件,然后单击Open
button。
4-在Documentation
菜单中selectBuild Project
。
完成此步骤后,帮助位于Sandcastle根文件夹项目和“帮助”文件夹中。
Live Documenter是一个.NET评论文档工具。 适用于所有版本的.NET,似乎支持所有的新function。
我不敢相信已经有11个小时了,没有人提到NDoc ,这正是你要找的。
我使用这个,只是因为Sandcastle在我需要的时候还没有准备好: CodeDoc
编辑 – 我使用Internet Explorer在那个工作,只是意识到该网站似乎并没有在Firefox中工作:(