Generally these tools make it for a better experience for the developer, saving both time and effort in long projects. GhostDoc is one I've been using especially in Visual Studio 2010 to help with documentation, so I decided to write a brief blog post on how it works and what it does.
GhostDoc comes in two different versions (free or paid) and works with both C# and VB.Net.
I've been using the free version, which accomplishes exactly what I need it to do. Once it is installed browse to your class/code that you have created:
Right click on the section you wish to create comments on, which could be the Class, Variable or Sub/Function declaration - and Click "Document This!":
GhostDoc will auto generate comments on each section, and on Sub/Functions will try to guess what the function is used for, along with what Parameters are expected.
It is a basic add-on, but I have found that even the simple add-ons add extra value.
Documentation is a normal practice used in the Industry, so this add-in will definitely help you with this. It integrates perfectly in the Visual Studio IDE.
Download a trial of Visual Studio 2010.
About the author
Stephen Aitchison is senior developer at Aura Redeye Security Ltd. You can find him on Twitter as @NZCoderGuy and on Geekzone as well.
Other related posts:
NuGet Package Manager extension for Visual Studio 2010
Getting Started with Visual Studio LightSwitch 2011
Comment by Daniel Ballinger, on 13-Dec-2011 10:22
Personally I don't find much value from a tool like GhostDoc if the generated documentation stubs are left as is. You don't get any information that couldn't otherwise be inferred from the code itself. Adding some additional information beyond the method and parameter names will help other developers who are using the code. E.g. Is there a limit on the length of the name field? Can it be null? In what cases will an exception occur.
Add a comment
Please note: comments that are inappropriate or promotional in nature will be deleted.
E-mail addresses are not displayed, but you must enter a valid e-mail address to confirm your comments.
Are you a registered Geekzone user? Login to have the fields below automatically filled in for you and to enable links in comments. If you have (or qualify to have) a Geekzone Blog then your comment will be automatically confirmed and shown in this blog post.