Documentation

GhostDoc

Written by: James Avery at 3/1/2008 9:53:52 PM

GhostDoc is one of those add-ins that you will quickly wonder how you lived without. GhostDoc is an add-in that automatically generates C# documentation based on the name and parameters of what you are documenting.

After downloading and installing GhostDoc you simply need to right-click on a method, class, property, etc. and then click the Document This button. If I started with this method declaration:

private void CheckSpelling()

{

 

}

After clicking the DocumentThis button I would now have:

/// <summary>

/// Checks the spelling.

/// </summary>

private void CheckSpelling()

{

 

}

GhostDoc simply looks at the method name, and based on recommended naming conventions as well as it's own rules, generates the monotonous part of C# documentation. This isnt a replacement for commenting your code, but just a quick shortcut to stop from having to write the monotonous part of C# documentation. After GhostDoc gets you started it is then up to you to add additional examples and complete the documentation of your code.

You can read more about GhostDoc on its homepage or in Hack #69 - "Create Comments Faster" in the book. (The hack was actually written by Roland Weigelt the creator of GhostDoc)

Download

blog comments powered by Disqus