从C＃XML注释生成文档 [英] Generating Documentation from C# XML Comments

问题描述

最近我开始一个新的项目，我第一次使用C＃。我发现，尽管Visual Studio有助于创建C＃的XML注释来记录您的类和方法，但是您可以做多少生成MSDN或Javadoc样式文档。

Google告诉我，Visual Studio 2003包含一个工具来生成这样的文档，但它不再包含在IDE的更高版本中。

如果我想利用我精心制作的（我向你保证）XML标记，我有什么选择？谢谢你的答案，但是Sandcastle似乎有点痛苦的配置和使用，所以我一直在寻找。我刚刚发现了另一个选择 - Doxygen 。

Doxygen生成javadoc样式文档，尽管它看起来主要是为了从您的注释中的自定义标记生成文档。显然，Doxygen还支持C＃XML Comments，尽管我们在他们的网站上找不到任何提及。

无论如何，我推荐它。它很容易使用，支持多种语言，并为您生成类图。

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.

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.

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

解决方案

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 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屋！