GhostDoc 2.1.1 Released

July 4, 2007 at 10:13 pm | Posted in Visual Studio | Leave a comment

A new version of this useful Visual Studio code commenting plug-in has been released. It supports C# and VB.NET.

A few people have mentioned to me that they think that “GhostDocing” or auto commenting source code is a waste of time and does not provide any value comments because it fills code methods, properties, interfaces etc with default comments based on rules. Even though the rules provide some pretty cool results, they are still simple comments. There are thoughts that this is a waste of time only only meaningful comments should be written.

The reason I like using GhostDoc so much is that it provides an accurate xml code comment template based on the method signature/template. I can then quickly edit the default comment with my own comments. Now what’s really cool is if I then refactor the method and change the signature around, add/remove parameters, swap them around, all I have to do is press Ctrl-Shift-D and GhostDoc fixes up the code template. This saves a lot of time of mucking around with the XML comment.

The only feature that I think GhostDoc is lacking is the ability to auto document an entire class. It only supports commenting elements one at a time.

See the blog entry here. GhostDoc 2.1.1 Released

Advertisements

Leave a Comment »

RSS feed for comments on this post. TrackBack URI

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

Create a free website or blog at WordPress.com.
Entries and comments feeds.

%d bloggers like this: