Roland Weigelt

Born to Code

News

.NET related Links

Archives

GhostDoc 2.1.1 Released

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

20070624_GhostDocQuick Facts

  • Bugfix release
  • Download on the GhostDoc Website
  • Users of earlier versions: Please read the ReadMe on upgrading!

About this Release

While adding VB.Net support in 2.1.0 I somehow introduced a bug that broke a few things, causing the “Document this” command to not work properly in some situations. In full accordance to Murphy’s Law the bug was hidden in the thin layer between Visual Studio and the main portion of GhostDoc that isn’t covered by unit tests…

What’s New in GhostDoc 2.1.1:

  • Added: A bit more detailed logging information at certain places. Please take a look at the topic “How to Enable Logging” in the help file for details.
  • Fixed: "Document this" not working on properties defined in interfaces.
  • Fixed: Readonly properties in interfaces not recognized properly in VB.Net.

Comments

Christian Eriksen said:

This add-in is perfect, I just love it. Thanks for your excellent work on this.

# August 25, 2007 11:23 PM

Tom said:

Does GhostDoc support formatting customization? For example, I would like for it to insert a new-line to

prevent comments from extending beyond column 80. Also I would like the xml comment tags to be on a line by themselves (e.g. <returns>\nA hash code for the specified object.\n</returns>).

Regardless, this is a great tool. Thanks.

# September 5, 2007 8:59 AM

WeigeltRo said:

Custom formatting, a customizable threshold for switching from single to multi-line etc. is on the list of TODOs for one of the next feature releases (whenever this may be...).

# September 7, 2007 5:56 PM

Ashvin Gunga said:

I downloaded GhostDoc today and gave it a try...and the initial impression is great..i like it ;-) and it indeed fits well in the daily life of a programmer..great piece of work!

# September 10, 2007 10:40 AM

WeigeltRo said:

Hi Matt, please define "big" projects (how many files etc.?)

# September 25, 2007 6:08 PM