Documenting .NET classes
-
What's the best way to document classes that you write in .NET? I know C# has some XML-comment documentation abilities, but VB .NET is limited. Plus the output of those is rather ugly. I would like to be able to deliver nice "MSDN-looking" HTML documenation to the developers who will be using my classes, but I don't want to spend more time on the docs than on the code! Barry Etter
-
What's the best way to document classes that you write in .NET? I know C# has some XML-comment documentation abilities, but VB .NET is limited. Plus the output of those is rather ugly. I would like to be able to deliver nice "MSDN-looking" HTML documenation to the developers who will be using my classes, but I don't want to spend more time on the docs than on the code! Barry Etter
The support for XML documentation provided by the C# compiler is very nice... using the xml output it produces combined with a tool like NDoc[^] creates very nice "MSDN-looking" documentation. Or if you don't want to use NDoc, you can always create your own XSL stylesheet to process the xml documentation. It's too bad that the VB.NET compiler does not support the same feature. You may want to look at the following: http://vb-doc.sourceforge.net/[^] http://www.fesersoft.com/products/VBXmlComments/[^] http://vbxmldoc.tor-erik.net/[^] I haven't used any of these, so I can't offer a recommendation. But one may be what you're looking for.