Roland Weigelt

Born to Code

News

.NET related Links

Archives

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

  • Support for VB.Net added
  • Full support for events, including inherited documentation and user-defined custom rules.
  • Download on the GhostDoc Website
  • Users of earlier versions: Please read the ReadMe on upgrading!

About this Release

For Visual Basic developers, version 2.1 is what 2.0 should have been: VB.Net support has been added again. Even though I got help (huge thanks to Daniel Root for the translation of the demo project), I spent more time than I wanted on testing, debugging and deployment – in the end it’s a huge number of small things that add up.

C# developers who have to implement many interfaces with events (like I do) will enjoy the full support for events, as it includes a text generation rule for using inherited documentation (VB.Net developers benefit from this of course, too).

What’s New in GhostDoc 2.1.0:

  • Added: Support for Visual Basic .NET has been added again (was disabled in version 2.0.0), but still is regarded as "experimental". The feature is turned off by default and you have to turn it on in the configuration dialog. Please see the docs for more information.
  • Added: The setup for the demo project now contains a VB.Net version.
  • Added: Full rule support for events (configurable default documentation, inherited documentation e.g. for interface implementations, and used-defined custom rules)
  • Added: New macro $(DeclaringTypeKind) that specifies the kind of type a member is defined in (i.e. class, struct or interface).
  • Changed: All occurrences of "class" in the default templates have been replaced by $(DeclaringTypeKind).
  • Changed: As the next version of Visual Studio (codename "Orcas" ) will be named Visual Studio 2008, all texts have been updated accordingly.
  • Fixed: Documentation of constructors of structs referring to the initialization of a "class" instance.
  • Fixed: Problems with parameter names starting with an '@' (e.g. "@class").

Comments

Joe said:

Salute! Our team is very excited to see VB is again supported with even more cool features.

# June 24, 2007 8:23 PM

.NetKicks said:

Gute Arbeit Roland, weiter so! Langsam aber sicher wird GhostDoc zu meinem lieblingsplugin...

# June 26, 2007 3:28 PM

Bernie said:

Perfektes Tool!

Leider funktioniert aber die Dokmentation von Inner Types (geschachtelte Klassen) seit dieser Version nicht mehr?

# July 3, 2007 8:02 AM

WeigeltRo said:

Ich habe anscheinend beim Umbau für die Unterstützung von VB.Net ein paar Sachen kaputt gemacht -- die Dokumentation von Properties in Interfaces funktioniert auch nicht mehr. Leider tritt der Fehler in einem Bereich auf, den ich nicht mit Unit-Tests abdecken konnte (Zugriff auf File Code Model in VS), und bei den manuellen Tests habe ich anscheinend keine volle Abdeckung erreicht.

Könntest Du bitte mal das Logging einschalten (siehe ghostdoc.12.forumer.com/viewtopic.php) und dann (nach einem Neustart von VS) nochmal probieren? Die Informationen im EventLog könnten mir einen Hinweis auf das Problem geben.

# July 3, 2007 8:13 AM

Bernie said:

Konnte es nun leider nicht mehr reproduzieren. Scheint evtl. doch ein anderes Problem gewesen zu sein .. sorry! (Es war übrigens in C#.)

Das einzigste, was ich feststellen konnte war, dass ich bei der Installation diesmal 'Upgrade' gewählt hatte, anstatt die Default-Konfiguration zu übernehmen ... aber nun ist alles bestens.

Danke!!!

# July 4, 2007 10:01 AM

WeigeltRo said:

Anmerkung: Die o.g. Probleme mit dem File Code Model sind in 2.1.1 behoben (weblogs.asp.net/.../3009402.aspx).

# July 4, 2007 10:06 AM