XML Code Commenting And Automated Code Documentation

[ 1 ] Comment
Share

Im sure those that have been developing with C# already know about the automated code documentation that Microsoft introduced in Visual Studio .NET 2003. Unfortunately for us VB.NET developers theres no support built in for this as yet.

There is a few other options which I have been playing with recently.
Check out: VBCommenter Powertoy for Visual Studio.NET 2003

The powertoy basically allows you to do the same thing that the Visual Studio.NET 2003 built in functionality does for C#
If you have looked at it you would notice its slightly restrictive in what commnents are available.

I have found a brillent article on customising this.
Check out: Customizing the VBCommenter Powertoy

This adds some addtional options and features. It is still not as in depth. I have also found many bugs with this. The customised tutorial was built on version 1.1 of the VBCommenter Powertoy. I am currently migrating it to the latest version which is version 1.25 (final), very simple changes and fixing a few of those bugs.

Once you have all you XML comments in there, run it through NDoc Code Documentation Generator for .NET and you have your MSDN style documentation :)

I’ll post a download for the modified version soon.

Currently Playing: Moby – Look Back In

One Response To XML Code Commenting And Automated Code Documentation

  1. Daniel says:

    Thank you for the info!