Really Good Visual Studio Plugin - "Ghost Doc"

I have recently become aware of a plugin for Visual Studio called Ghost Doc.  You right click on a piece of code and click "Document This" or alternatively I assigned ctrl + shft + D to do it for me.  It is that easy, and boy is it useful.  Nice and quick.

 

Download from : http://www.roland-weigelt.de/ghostdoc/

 

Some Examples

The context menu

image

A property documented

image

OK, not completely there, but a total time saver none the less.

image

 

While I have complete respect for the person who made this plugin, it would have been nice to see it pick up on any exceptions which are thrown.  When intellisense sparks off, I love seeing what potential exceptions could be thrown so I can code for any circumstance nice and cleanly.  Again, as I say, this is a rally useful tool and I feel it is a great time saver!

 

UPDATE:

LOL I have unknowingly stumbled on a little cool piece of this plugin.  Notice in my last screen shot I called it TestThisMethod.  The documentation actually breaks that into a grammatical sentence "Tests the this method," which I have to applaud!  WELL DONE GHOST DOC!! lol

 

Cheers,

 

Andrew

Published Thursday, May 08, 2008 2:32 PM by REA_ANDREW

Comments

# re: Really Good Visual Studio Plugin - "Ghost Doc"

Thursday, May 08, 2008 10:31 AM by pbz

Or maybe it picks up from the summary? :)

# re: Really Good Visual Studio Plugin - "Ghost Doc"

Thursday, May 08, 2008 12:18 PM by Dave T

We went hog wild with that plugin. Gosh I wish I hadn't of done that. Commmenting methods for the sake of commenting them is rather "noisy". Now I have to scroll by all this useless help information.

# re: Really Good Visual Studio Plugin - "Ghost Doc"

Thursday, May 08, 2008 6:22 PM by REA_ANDREW

Its cool int it!  Really nice plugin! :-)

# re: Really Good Visual Studio Plugin - "Ghost Doc"

Saturday, July 25, 2009 6:00 PM by mickeysteib

I am suspicious when I hear people talk about "useless help information" with an idea that commenting is "for the sake of commenting." Life is full of stuff that we scroll by, and now and then notice as useful in nudging us away from mistakes.

Leave a Comment

(required) 
(required) 
(optional)
(required)