<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 2.1.3 for Visual Studio 2005 requires a non-Express version of Visual Studio 2005, Express versions are not supported.
• Note that development for Visual Studio .Net 2003 has been frozen, the most recent version is GhostDoc 1.3.0, which can be downloaded at http://www.roland-weigelt.de/ghostdoc.
• Versions for Visual Studio 2005, Visual Studio 2008 and Visual Studio .Net 2003 can be installed side-by-side into different folders. Note that the versions for Visual Studio 2005 and 2008 intentionally share the same configuration file.
• If you had an earlier version of GhostDoc installed, please make sure you read the instructions regarding upgrading.

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.
• Uninstall GhostDoc 1.9.0
• Start Visual Studio 2005 once, then exit (IMPORTANT). This will clean up some things.
• Follow the instructions for installing 2.1.3 below.

Upgrading from 1.9.1 or later

• Close all instances of Visual Studio.
• Uninstall GhostDoc. Your existing configuration will not be removed from your system.
• Follow the instructions for installing 2.1.3 below.

Installing 2.1.3 and First Steps

• Make sure all instances of Visual Studio are closed when installing GhostDoc.
• Double-click the file GhostDoc2.1.3.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.
If you had a previous version of GhostDoc installed before, you will be offered to upgrade the configuration.
• 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. The Windows start menu contains a sub-menu Programs -> Weigelt -> GhostDoc for VS 2005 with a shortcut to the help file.
• Even if you hate reading manuals, you should 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 ;-)

A Note to Visual Basic .NET Developers

Support for Visual Basic .NET is regarded as "experimental" and is disabled by default. It can be enabled on the "Options" tab of the configuration dialog (inside Visual Studio: Tools -> GhostDoc -> Configure GhostDoc).

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).