生成从C＃XML文档的评论 [英] Generating Documentation from C# XML Comments

问题描述

我最近开始了一个新项目，我使用C＃首次。我发现，尽管Visual Studio是创建C＃的XML注释记录您的类和方法的帮助，有没有什么可以做，以生成MSDN或风格的Javadoc文档。

I've recently started a new project and I'm using C# for the first time. I've found that while Visual Studio is helpful in creating C#'s XML comments to document your classes and methods, there's not much you can do to generate MSDN or Javadoc style documentation.

谷歌告诉我，Visual Studio 2003中包含的工具来生成这些文件，但它不再包含在IDE的更高版本。

Google tells me that Visual Studio 2003 included a tool to generate such documentation, but it is not longer included in later versions of the IDE.

什么是我的选择，如果我想利用我的精心打造（我向你保证！）XML标记？

What are my options if I wish to make use of my carefully crafted (I assure you!) XML markup?

推荐答案

感谢您的答案，但沙堡似乎有点痛苦的配置和使用，所以我一直在寻找。我刚刚发现了另一个选择 - 。 Doxygen的

Thanks for the answers, but Sandcastle seems a bit painful to configure and use so I kept looking. I've just found another alternative - Doxygen.

Doxygen的产生的Javadoc风格的文档，虽然它看起来像它的主要目的是你的评论内生成自定义标记的文档。显然，Doxygen的也支持C＃XML注释，虽然我找不到它的任何提及他们的网站上！

Doxygen generates javadoc style documentation, although it looks like it's primarily intended to generate documentation from custom markup within your comments. Evidently, Doxygen also supports C# XML Comments, although I can't find any mention of it on their website!

无论如何，我推荐它。它使用方便，支持多语言并且还生成类图给你。

Anyway, I recommend it. It's easy to use, supports multiple languages and also generates class diagrams for you.

这篇关于生成从C＃XML文档的评论的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！