Have a question? Email Us or Call 1 (800) 936-2134
SubMain - CodeIt.Right The First Time! Home Products Services Download Purchase Support Community

GhostDoc

Simplify your XML Comments!

Latest build:
4.9.14150    [New]
Release date:
May 30, 2014
Changelog:
view
News Feed
Supported IDEs:
Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Supported Languages:
VB.NET
C#
C/C++

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.

Benefits

  • Save keystrokes and time; simplify documenting your code
  • Benefit of the base class documentation
  • StyleCop compliant documentation templates
  • XML Comment Preview
  • (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.

Introduction to GhostDoc (3 min)

View the Video

What's new

New in version 4.9

  • (Ent) Add custom content to the generated API documentation
  • GhostDoc Enteprise version with silent deployment and advanced configuration
  • (Pro) Help Configurations and 'filtered' help file
  • (Pro) Embed images into help file markup
  • (Pro) Hyperlinking to base .NET Framework classes

Help Documentation Samples

To see sample help documentation created with GhostDoc Pro and GhostDoc Enterprise, visit this page.

Editions

In addition to standard features the free version GhostDoc offers, there is a GhostDoc Pro alternative which provides ultimate documentation configuration flexibility and automation of routine documentation operations.

For complete edition comparison see this page.

  GhostDocGhostDoc Pro
Features
Build Help File
create your XML Documentation CHM help file with a single click
 
XML Comment Preview
See your comments as they appear in the help file
 
Code Spell Checker
Spell Checking for XML Comments, code elements, literals and comments
 
Document This
Generates XML comments based on code element type, parameters, name, and other contextual information
Document Type
Generates XML comments for entire type/class
 
Document File
Generates XML comments for entire file
 
For a derived class uses the base class documentation.
Configurable rules, acronyms and macros
XML Comment templates (T4)
Total control over your XML documentation content and style
 
Assignable shortcut (default Ctrl-Shift-D)
Import/Export of the configuration and the rules
Option to re-build documentation
Licensing
Personal License
For individual developers
Free $50/user
Commercial License
For companies and organizations
N/A $80/user
License Protection
One time charge provides minor and major upgrades for the product lifetime
N/A $30/user
Links & Resources
Automate your XML Comments with CodeIt.Right IntelliComment feature

Support, Feedback, etc

GhostDoc Discussion Forum
A forum for support and discussion related to GhostDoc
http://community.submain.com/forums/30/ShowForum.aspx

If you think that something could be improved, let us know , we are happy to hear your ideas.

 

 
     
 
Home |  Products |  Download |  Purchase |  Support |  Privacy |  Terms |  About Us |