Generate HTML documentation from C# comments
May 25, 2009
When developing .NET applications, XML comments is a good way of documenting the code. These comments can then be used to generate HTML documentation. Let’s have a look at how to do this.
If you are not familiar with documenting your C# code with XML comments, have a look at this page.
Basically, XML comments lets you document your code in a way that makes it possible to generate documentation for your types and their properties, attributes, methods etc. XML comments are also automatically parsed by Visual Studio to provide tools like IntelliSense and code completion.
Other ways of documenting your code is to use plain text files (classic readmes), wikis etc. as well as common inline comments. However, if you want to be able to generate documentation from your .NET source code, XML comments is the way to.
This is how you do it.
Generate an XML file from your XML comments
If you have documented your code with XML comments, Visual Studio can export the
documentation to a separate .xml file when you build your project. This is enabled
If you enable
.xml file extraction, Visual Studio will generate an .xml file each
time you build your project. This file can then be parsed by various software to
generate help files, documentation etc.
However, if you want to publish your documentation, .xml files only takes you so far. A better option is then to generate HTML documentation and host it on a web site.
Generate HTML documentation from XML comments
Previous versions of Visual Studio had built-in support for generating HTML-based documentation from C# code. However, I think Visual Studio 2003 was the last version to have it. We need an alternative.
After looking for a .NET version of phpDoc and JavaDoc, I found Doxygen. After giving it a try, I found this walkthrough to work well:
To get started, download, install and start Doxygen, then configure it like this:
- Enter project name and version - this will be used as page title
- Point out the source code root folder, which is where your source code is
- Check Scan recursively to make sure that all namespace folders are parsed
- Pick a documentation destination folder, which is where your HTML documentation will end up
- Instead of “Documented Entities”, select “All Entities”.
- “All Entities” will also extract a nice namespace list.
- Since we are extracting documentation for C#, select “Optimize for Java or C# output”
- Make sure that HTML is checked and choose the format you prefer.
- I like the frame/tree format, but this is just a matter of taste :)
- Latex, Man pages, RTF and XML are optional and not described in this post.
- Select “Use built-in class diagram generator”.
- Uncheck “FULL_PATH_NAMES” to avoid displaying file paths in the documentation.
- Check “EXTRACT_STATIC” to include static classes.
- Click “Run doxygen” to generate the HTML documentation.
- When it’s done, view the result by clicking “Show HTML output”.
When the HTML documentation is built, you can just upload it to wherever you want it to be available. If you’re happy with the outcome, save the config for future use.
Hope this helps!