<summary>
GhostDoc is a free add-in for Visual Studio that automatically generates XML
documentation comments for C#. Either by using existing documentation inherited
from base classes or implemented interfaces, or by deducing comments from
name and type of e.g. methods, properties or parameters.
</summary>

Important Information

System requirements

• GhostDoc 1.9.5 requires Visual Studio 2005 (Express versions not supported)
• The most recent version for Visual Studio .Net 2003 is GhostDoc 1.3.0, which can be downloaded at http://www.roland-weigelt.de/ghostdoc.
• Versions for VS2005 and VS.Net 2003 can be installed side-by-side

Installation

Upgrading from 1.9.0

• If you have customized your configuration, open GhostDoc's configuration dialog (Tools menu) and export the configuration to e.g. a file on the desktop or an other well-known location. You can import this file during installation.
• Close all instances of Visual Studio 2005.
• Uninstall GhostDoc 1.9.0
• Start Visual Studio 2005 once, then exit (IMPORTANT). This will clean up some things.
• Follow the installation instructions.

Upgrading from 1.9.1, 1.9.2 or 1.9.3

• Close all instances of Visual Studio 2005.
• Uninstall GhostDoc, do not perform an upgrade installation*.
• Follow the installation instructions.

*) Background info: This is due to a bug in MSI that strikes everytime something changes in the installer class - and for 1.9.4, the installer class had to be modified. If you perform an upgrade installation, the installer class of the old version (used during uninstallation) will be re-used by MSI for installation of the new version.

Upgrading from 1.9.4

• Close all instances of Visual Studio 2005.
• Install GhostDoc (no need to uninstall first).
• Follow the installation instructions.

Installing 1.9.5 and First Steps

• Make sure all instances of Visual Studio 2005 are closed when installing GhostDoc.
• Doubleclick the MSI file to install
• After the installation is finished, start Visual Studio to complete the setup. A few dialogs will guide you through the initial configuration
After installation, the Windows start menu contains a sub-menu
Programs -> Weigelt -> GhostDoc for VS2005
with shortcuts to the help file and the demo project.
• If you are new to GhostDoc, it's a good idea to read the introduction of the help file to got a basic understanding of what GhostDoc is and what it is not.
• Even if you hate reading manuals, you should at take a look at the help file. Just follow the topic "How do I see some action without reading boring stuff?" on the start page ;-)

Troubleshooting

• If you run into problems after installation, make sure to read the troubleshooting guide on the "Quick Start" page in the help file (it's the second page after the welcome page). You can access the help file either using the Windows program menu or from the GhostDoc configuration dialog.

Contact

GhostDoc has a discussion forum for posting questions, bug reports or feature requests. If you want to contact me in private, you can write an email to ghostdoc@roland-weigelt.de (in English or German).