Have a question? Email Us or Call 1 (800) 936-2134
SubMain - Code Quality Tools, Automated Code Review and Refactoring Home Products Services Download Purchase Support Community

GhostDoc

Painless Code Documentation

Latest build:
2018.1.18250    [New]
Release date:
Sep 7, 2018
Changelog:
view
News Feed
Supported IDEs:
Visual Studio 2017
       incl. Community Edition
Visual Studio 2015
       incl. Community Edition
Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Supported Languages:
C#
Visual Basic
C++/CLI
JavaScript

GhostDoc is a Visual Studio extension for developers who need to Generate XML Comments from source code using customizable templates, maintain clean and up-to-date documentation, produce help documentation in multiple formats, use intelligent source code Spell Checker in Visual Studio, and more.

GhostDoc also helps automating the generation of clean, helpful documentation of your clean code, building it, and packaging it up all without human intervention.

What's new in version v2018

  • Visual Editor for XML Comments
  • New output format - VS IntelliSense file
  • Document Project and Document File Header commands
  • Support for <inheritdoc /> tag
  • Frameless web help documentation themes
  • Include Code Contracts into help documentation
  • Use regular expressions with the Summary Override feature

For the details, please see What's New in GhostDoc v2018

Introduction to GhostDoc (3 min)

View the Video

Benefits

  • Automatically generate a starting point for your help documentation
  • Benefit of the base class documentation
  • Visual Editor for XML Comments
  • Produce help documentation in multiple formats
  • Maintain clean and up-to-date code documentation
  • Generate help documentation from your build
  • Contemporary help documentation themes
  • Intelligent source code Spell Checker
  • StyleCop compliant documentation templates

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.

Help Documentation Samples

To see sample help documentation created with GhostDoc Pro and GhostDoc Enterprise, visit this page. Version 5.0 adds theme support and two new themes - FlatGray and FlatMain. Version v2018 adds contemporary frameless web help documentation themes.

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 ProEnterprise
Features
Visual Editor for XML Comments
create your XML Documentation CHM help file with a single click
Automatically generate starting point for your help docs
Generate XML comments based on code element type, parameters, name, and other contextual information
XML Comment batch actions
Generate XML comments for entire Type, File or Project
 
Produce help documentation in multiple formats
See your comments as they appear in the help file
 
Maintain clean and up-to-date code documentation  
Generate help documentation from your build
Command line version for Continuous Integration/Build Process
   
Contemporary help documentation themes  
Intelligent source code Spell Checker
Spell Checking for XML Comments, code elements, literals and comments
 
Benefit of the base class documentation
Configurable rules, acronyms and macros
XML Comment templates (T4)
Complete control over your XML documentation content and style
 
Add custom content
Add your own content to the generated API documentation using Conceptual Content
   
Unattended deployment and activation    
Enterprise Licensing Server option
Option to enable in-house product activation
   
Licensing
Personal License
For individual developers
Free $50/user $170/user
Commercial License
For companies and organizations
N/A $100/user $170/user
Software Assurance subscription
Annual subscription add-on provides minor and major upgrades during the cover period
N/A Available Available
  Download Download Download
 

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