C# documentation from source?

Question

Hello,

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

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.

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.

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

Answer 1

Since Sandcastle's output is "what you want", may I ask if you're familiar with Sandcastle Help File Builder? It's a GUI that automates most of the tediousness away.

Answer 2

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).

Answer 3

May I humbly suggest to try ImmDoc.NET - a simple project I've developed some time ago and recently published on CodePlex. It is light-weight, very easy to use and supports .NET 2.0. It can also create CHM output.

Answer 4

We have used DocumentX and HelpStudio from InnovaSys for several years to generate documentation for our .NET components. According to the InnovaSys web site, DocumentX is used by a number of leading component vendors:

"Used by leading component vendors including Infragistics, Janus, Data Dynamics, Dundas, SpreadsheetGear and telerik to produce their commercial technical documentation."

My favorite DocumentX feature is the fairly comprehensive WYSIWYG editor which works right in Visual Studio. My only complaint is the fact that building help is a bit on the slow side - but the benefits definitely make up for this.

I have no interest in InnovaSys other than the fact that I am a happy user of their product.