Be developer, anyone always would like to develop coding skill fast and effectively.
Be developer, anyone is always aware of that using naming convention will make your code more professional. Writing comment in your source code is one of important element of naming convention. It makes your source easy to understand and easy to maintain but it also takes you a lot of time to do, of course.
In Visual Studio, when we type three “/” characters continuously like this “///” above the code line of method or class, it will auto generate comment like in below red rectangle.
It looks pretty great, but with GhostDoc, it brings you more. This tool is really helpful for you to generate code comments automatically. It saves more a lot of your time when coding.
This free tool supports VS2005,2008,2010, we will see this while installing.
Now we begin to enjoy this tool :).
1. Download GhostDoc and install
2. After finish installation, open Visual Studio, this below screen appears and request you to assign a hotkey for automatic comments generation, the default hotkey is Ctrl + Shift + D, you can choose another hotkey in the dropdownlist “Hotkey”.
3. Open a certain CSharp or VB.NET file.
Focus the mouse on the name of method, right click choose “Document This” or press hot key “Ctrl + Shift + D“
The comment is generated as below. It generates description of the method name, variable name. The more meaning naming convention you declare(ex : CheckUserLogin, userName, password), the more specified description you get.