Mark B. – tech

GhostDoc – automatic generate code documentation

Simplify your XML Comments!


GhostDoc is a Visual Studio extension that automatically generates XML documentation comments for methods and properties based on their type, parameters, name, and other contextual information.

When generating documentation for class derived from a base class or for interface implementation (e.g. .NET Framework or your custom framework), GhostDoc will use the documentation that Microsoft or the framework vendor has already written for the base class or interface.

Benefits

  • Save keystrokes and time
  • Simplify documenting your code
  • Benefit of the base class documentation

If you follow good naming conventions in your code, then you will get very decent results on the summary GhostDoc generates.  When I see code that is not documented, it is as simple as hit Ctrl-Shift-D to have GhostDoc document it.

Supported IDEs:
 Visual Studio 2010  Visual Studio 2008  Visual Studio 2005

Supported Languages:
 VB.NET  C#
more info : Submain – GhostDoc
Advertisements
This entry was published on February 15, 2012 at 7:58 am and is filed under IT, Programming. Bookmark the permalink. Follow any comments here with the RSS feed for this post.

2 thoughts on “GhostDoc – automatic generate code documentation

  1. great post, very informative. I wonder why the other specialists of this sector do not notice this. You must continue your writing. I am sure, you have a huge readers’ base already!

  2. Hi there, You have done a fantastic job. I�ll certainly digg it and personally recommend to my friends. I am sure they will be benefited from this website.

Leave a Reply

Fill in your details below or click an icon to log in:

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: