Sign in
in
   
"It is the mark of an educated mind to be able to entertain a thought without accepting it."  -Aristotle

About Me

I am a co-founder of Notches, an early stage startup currently based in NYC. We are building a free, open reviews network that anyone can participate in and anyone can build on top of. You can find out more on our official blog.

Read more about my background.

Connect with me on...

Recent Readers

Flickr Photos

 

Warning:

This article is more than 45 days old. Given the speed at which the technology world moves, this post is probably somewhat out of date. Please keep this in mind when reading the post. If this is a tutorial, please check whether you are using the same versions mentioned in the article.

(Developer) Productivity Tool of the Week: GhostDoc

Dave recently turned me on to GhostDoc , a (free) add-in for Visual Studio that automatically generates documentation.  ( One of MSDN's 10 must-have add-ins in the last issue ). The VS2003 add-in has been available for awhile and a VS2005 version has also been released.

GhostDoc is a free add-in for Visual Studio that automatically generates XML
documentation comments. Either by using existing documentation inherited
from base classes or implemented interfaces, or by deducing comments from
name and type of e.g. methods, properties or parameters.

It's really a great time-saver for generating baseline documentation. It's pretty powerful if you follow a consistent set of conventions (you can customize the rules to fit your particular style).

Definitely worth a download.

Only published comments... Dec 29 2005, 12:17 PM by Tim

View related posts

 

Josh Einstein said:

Everyone who has mentioned this add in forgets to mention the most useful part of it... The auto generated documentation is mostly useless unless you really don't care about documenting something and you're just trying to get rid of the XML doc compiler warning. BUT the best part about GhostDoc is that it will hoist documentation up from inherited members or implemented interfaces! Now THAT is a time saver. I love GhostDoc for this reason alone and I don't think I could ever go back to copy/paste.
January 31, 2006 7:18 PM
 

Josh Einstein said:

Sorry, duh I must have completely skipped over the indented, quoted part. :)
January 31, 2006 7:19 PM