从源代码C＃文档？ [英] C# documentation from source?

问题描述

我在寻找一个体面的代码文档生成的C＃，它可以创建直接从源代码的HTML格式的文档。

I'm looking for a decent code documentation generator for C# that can create an html-format documentation straight from source.

我不想用沙堡，因为它太繁琐使用，我不使用VS我的工作，虽然沙堡的输出是正是我需要的。

I don't want to use Sandcastle, because it's too tedious to use and I don't use VS for my work, though Sandcastle's output is exactly what I need.

我还需要使用Doxygen的功能 - 只保存一个文件，按下一个按钮，进出自带的文档。问题是，Doxygen的不会产生MSDN般的输出。

I also need the functionality of Doxygen - just save a file, press a button, and out comes documentation. The problem is that Doxygen doesn't produce an MSDN-like output.

自定义的风格将是一个加号，以及用于很多其他的样式，比如原型，花支持，VS2005等。

Customizable styles would be a plus, as well as support for plenty of other styles like prototype, hana, vs2005, etc.

推荐答案

您不指定是否想要的东西，开源与否，所以我会建议一个商业包装，DOC-O-MATIC（从toolsfactory.com）。它的高度可配置的，并在源（或XDOC风格的javadoc）处理意见。它会产生的.chm或.html，.pdf和HELP2格式（这将与Visual Studio集成）。我觉得有一个免费试用。用户界面是有点笨重，它需要一段时间才能理清所有设置，但总的来说它工作得很好。我用它来记录一个.NET API（C ++中）和一个COM API（在VB中）。

You don't specify whether you want something open source or not, so I'll suggest a commercial package, Doc-o-matic (from toolsfactory.com). It's highly configurable, and handles comments in the source (either xdoc or javadoc styles). It will produce .chm, .html, .pdf, and Help2 format (which will integrate with Visual Studio). I think there's a free trial. The UI is a bit clunky and it takes a while to sort out all the settings, but in general it works very well. I've used it to document a .NET API (in C++) and a COM API (in VB).

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