Questions tagged [ghostdoc]

GhostDoc is a Visual Studio extension that automatically generates XML documentation comments for methods and properties based on their type, parameters, name, and other contextual information.

When generating documentation for a class derived from a base class or for interface implementation (e.g. .NET Framework or your custom framework), GhostDoc will use the documentation that Microsoft or the framework vendor has already written for the base class or interface.

Benefits

  • Save keystrokes and time
  • Simplify documenting your code
  • Benefit of the base class documentation

If you follow good naming conventions in your code, then you will get very decent results on the summary GhostDoc generates. When you see code that is not documented, it is as simple as hitting Ctrl + Shift + D to have GhostDoc document it.

Editions

In addition to standard features the free version GhostDoc offers, there is a GhostDoc Pro alternative which provides ultimate documentation configuration flexibility and automation of routine documentation operations.

http://submain.com/products/ghostdoc.aspx

49 questions
0
votes
1 answer

Configuring GhostDoc to comment public accessors only

How can I configure GhostDoc to comment only public accessors only? I've looked at the "rules" configuration, but did not see any information/variables indicating accessor type.
d.moncada
  • 16,900
  • 5
  • 53
  • 82
0
votes
1 answer

GhostDoc element ordering / customization

How can I customize GhostDoc to do the following? ///Moo /// /// Gets the user by ID. /// ///The ID. /// ///12/4/2012-11:23 AM Basically I want to…
niklr
  • 1,671
  • 3
  • 24
  • 40
0
votes
1 answer

What would be some particular benefits to using GhostDocs with C#

The whole point of GhostDocs is obviously to document your code. It asks you to name your methods well to do so. With well named methods however, theoritically shouldn't they be useful enough to be considered documentation? I just want to hear some…
SamuelDavis
  • 3,312
  • 3
  • 17
  • 19
0
votes
1 answer

GhostDoc - Updating derived class comments

I have an interface (ISomeInterface) with full xml comments, and some derived classes with matching xml comments. If I change the comment in the interface, is it possible to update the comments in all derived classes with GhostDoc (or any other…
Brett Postin
  • 11,215
  • 10
  • 60
  • 95
1 2 3
4