Documenting .NET Code

This post is based on Chapter 5 of Andrew Troelsen’s “Pro C# 2008 and the .Net Platform” availble from Apress.

You will no doubt know the general documentation syntax for methods and classes. Here are some tools and tips on how to leverage this into a full blown application documentation:

GhostDoc – is an excellent tool that allows you to define keyboard shortcuts for auto-generating comment blocks. With some practise and good naming practises this will take care of a lot of the work behind documenting your code.

Once you have all your comments ready, you can use the .NET commandline compilers and the /doc argument to generate an XML file from these. Once you have this, you can use tools like NDoc or SandcastleDocs to generate nice browsable documentation.

Advertisements

Leave a Reply

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: