Saturday , July 21 2018
Home / Dot Net / C# / GhostDoc Visual Studio extension

GhostDoc Visual Studio extension

GhostDoc is a code documentation tool.Every developer needs to document their code for example we write a method for display purpose then we have to document the method functionality (why this method will use and what it will returns and what type of parameters it accepts) so that other developers can easily understand the code

For Example below method returns STUDENT_DETAILS object and we have to specify the summary for this method and how many parameters it accepts

A project contains so many classes and every class contains so many methods and properties

so we have to document all the classes, Methods and Properties , but it is very time consuming task so we have to use any code documentation tool for performing this activity. GhostDoc is one of the code documentation tool

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.

What’s new

New in version 5.0

  • Documentation Quality hints in Visual Studio editor
  • Documentation Maintenance – find, edit or remove auto-generated comments; identify missing and out of sync comments
  • Help documentation theme support and new themes
  • Hide/show documentation comments
  • Options to mark comments as auto-generated and flag them ‘to be edited

Benefits

  • Save keystrokes and time; simplify documenting your code
  • Automatically generate a starting point for your help documentation
  • Benefit of the base class documentation
  • StyleCop compliant documentation templates
  • (Pro) Documentation quality and maintenance
  • (Pro) Code Spell Checker
  • (Pro) Build Help File
  • (Pro) Take control of your help files with Help Configurations and Template Libraries

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.

It Supports following Visual studio versions:

  • Visual Studio – 2017
  • Visual Studio – 2015
  • Visual Studio – 2013
  • Visual Studio – 2012
  • Visual Studio – 2010

It supports following Languages

  • C#
  • Visual Basic
  • C++/CLI
  • JavaScript

For more details see this video:

Download

Source: https://submain.com/products/ghostdoc.aspx?utm_campaign=ghostdoc&utm_medium=listing&utm_source=visualstudiogallery

Conclusion:

We hope you find the tip as helpful,  I hope you liked the article. Please share your valuable suggestions and feedback in the comments.

Print Friendly, PDF & Email

Give us your valuable feedback

comments

About Murali

Hello everyone I am Software Developer having 3+ years of Experience in Microsoft Technologies and Others. My skills :- Asp.net, C#,Ado.net, SQL SERVER, web services, windows Service,Windows applications,HTML,CSS, JavaScript,JQuery,AnjularJs

Check Also

studyclues_c_object

Lesson 8: Object In C#

c# object: A class and an object are different things. A class defines a type of …