Automatically XML Documentation For Code Using Ghostdoc Tool In Visual Studio In C# Code

Purpose

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

When generating documentation for a derived class from a base class or for an interface implementation (e.g. .NET Framework or your custom framework), GhostDoc will use the documentation, which 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
  • XML Comment Preview

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

Please follow the steps given below to install it in your machine.

Step 1

Download Ghostdoc from the URL given below http://submain.com/download/ghostdoc/

Step 2

Install this software in your machine.

Step 3

Make sure VS should be closed. If Visual Studio is open, please close and restart Visual Studio.

Step 4

Go to any code at the backend (or) the code (i.e. .Cs) page of it in your project. Right click above any method.

Step 5

You will get GhostDoc Pro option and subsequently click Document this.

Step 6

It will generate automatically XML Documentation for a particular method or properties, as shown below.

Tutorial References

It will give more idea about this tool.

http://community.submain.com/blogs/tutorials/archive/2013/03/28/how-to-access-ghostdoc-pro-features.aspx?utm_campaign=ghostdoc&utm_medium=email&utm_source=lifecycle

X

Build smarter apps with Machine Learning, Bots, Cognitive Services - Start free.

Start Learning Now