Roland Weigelt

Born to Code

News

  • Twitter: English | Deutsch
  • Meet me:
    .NET Open Space vom 17.10. bis 18.10.2009 in Leipzig
  • GhostDoc:
  • .NET User Group:
  • Personal homepage:
  • XING:
    XING

.NET related Links

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

This release contains minor updates of the documentation and changes regarding the text generation.

  • Changed: References generated by the $(ShortName...) and the $(FullName...) macros no longer generate the "T:" prefix, as this prevented the compiler from detecting broken references to renamed classes (thanks to forum user “erwind” for pointing out various issues with the "kind of" identifiers). Note that GhostDoc currently does not remove the qualifiers from inherited documentation.
  • Changed: Most generated texts now use the $(FullNameAsSee) macro, with the exception of the summary for constructors.

Download on the GhostDoc website.

Posted: Aug 04 2006, 04:20 PM by WeigeltRo | with 4 comment(s)
Filed under: , , ,

Comments

Marc said:

Works like a charm. One more nice feature would be to inherit ALL documentation from a base class / interface class. This helps to propagate comments to the higher classes if changes are made to the base class.

# September 19, 2006 5:00 AM

WeigeltRo said:

> One more nice feature would be to inherit ALL

> documentation from a base class / interface class.

When implementing an interface - maybe.

But when overriding base class members, it's necessary to check each and every item if the documentation still makes sense (at least if the goal is to provide GOOD documentation).

Maybe I cannot force people to take a look at the generated documentation, but I will not provide a feature that makes it too easy to ignore the generated text.

# September 19, 2006 7:15 AM

Steve said:

Not working so great, won't enable document this feature.

# September 26, 2006 2:11 PM

WeigeltRo said:

@Steve: In order to help you, I need a tiny little bit more info - which language (C#/VB.Net), what language element are you trying to document, etc.

By the way, did you turn on the generation of the documentation XML file?

But please let's move technical discussion to the GhostDoc forum (link on the GhostDoc website).

# September 26, 2006 2:46 PM