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
87
votes
3 answers

View all TODO items in Visual Studio using GhostDoc

I'm also using GhostDoc in Visual Studio 2008. How do I view all to-do items and if that's a function already in Visual Studio or in GhostDoc (the documentation tool that I use)?
PositiveGuy
  • 46,620
  • 110
  • 305
  • 471
23
votes
6 answers

At what point do Stylecop settings stop being useful and start becoming annoying?

I work in a team where we use extensive ruleset in StyleCop and I am wondering what are the thoughts on the general point where such a tool stops being useful and starts becomes annoying. We also use GhostDoc so code is riddled with XML comments…
Peter Kelly
  • 14,253
  • 6
  • 54
  • 63
17
votes
5 answers

How to intelligently fix documentation in Eclipse?

Back in my C# days, I loved using a Visual Studio extension called "GhostDoc". Now that I'm a being used as a Java developer I'm using Eclipse. I can live without being able to have inferred documentation, but something that I'd like to do is to…
Jason Thompson
  • 4,643
  • 5
  • 50
  • 74
12
votes
5 answers

GhostDoc Equivalent for Eclipse(Java)

I'm a big fan of GhostDoc's automatic comment generation in Visual Studio so am looking for an plugin that does the same job with my Java code in Eclipse. Any recommendations?
Duncan
  • 1,758
  • 6
  • 21
  • 34
10
votes
3 answers

Is there anything like GhostDoc for C++

When I'm developing in C#, I heavily use GhostDoc to speed up the process of commenting my code. I'm currently working on a C++ project and I haven't found an equivalent tool. I know about Doxygen, but from what I know it is used to create…
epotter
  • 7,631
  • 7
  • 63
  • 88
7
votes
1 answer

Ghostdoc-like plugin for IntelliJ IDEA

I've become lazy in my old age. For my C# work I've become quite reliant on Roland Weigelt's excellent GhostDoc plugin for Visual Studio. Is anyone aware of a similar plugin for Java work in IntelliJ IDEA?
Andrew
  • 11,894
  • 12
  • 69
  • 85
6
votes
5 answers

Is there a GhostDoc like plug-in for CodeRush or ReSharper?

I have noticed that GhostDoc hasn't been updated in a long while. So I am curious if there is a plug-in for Resharper or CodeRush that will accomplish the same thing? Or even if this type of functionality is built in to one of the tools that would…
Nick Berardi
  • 54,393
  • 15
  • 113
  • 135
5
votes
1 answer

How to remove XML comment element from a GhostDoc rule?

I do not want to document the element for C# properties. However, GhostDoc is configured to do exactly that. I thought it would be easy to remove it by visiting the configuration screen and just remove the element. But there is no button or…
Sandro
  • 2,998
  • 2
  • 25
  • 51
4
votes
1 answer

Manually VS IDE extension installation ? (GhostDoc extension)

The reason of this question is that I've made a silent installer of VisualStudio 2013 with some extensions and I would like to add the GhostDoc extension to the unatended process, but GhostDoc can't be installed like an VSIX file, it is an MSI…
4
votes
4 answers

R#: Stop it touching ghostdoc XML comments on Code Cleanup?

I am using GhostDoc to create my XML comments and I am very happy with the format. I use the following format (c#) /// /// Creates new client. /// /// The URI. ///
Martin
  • 23,844
  • 55
  • 201
  • 327
3
votes
0 answers

How do I customize the documentation template of GhostDoc Pro?

I don't like the standard XML-Style documentation of GhostDoc and would like to change it to something more inline with JavaDoc or at least to the standard way that Visual Studio adds comments in C# if you type /// So either: /** * @brief…
sro5h
  • 322
  • 2
  • 12
3
votes
1 answer

Is it possible to inherit comments in an abstract method's body from a BaseClass?

I have the PersonBaseClass and the EmployeeClass that derives from it. Now I'd like to define a method body as a comment in the BaseClass that when I use Resharper's "Implement Members" (or manually implement them) it also puts it in the method…
mYnDstrEAm
  • 751
  • 2
  • 8
  • 26
3
votes
3 answers

Can I use GhostDoc to add documentation to an entire class or code file?

I love GhostDoc, but I want to be able to "Document This" for an entire file, and not just one member at a time. Is this possible?
skb
  • 30,624
  • 33
  • 94
  • 146
2
votes
0 answers

Can GhostDoc be configured to keep value on a single line, leave summary on multiple?

I'm looking to configure GhostDoc so that the "value" is on a single line while the "summary" is always on multiple lines. There is an option for "Keep single line when under..." but it works on both "summary" and "value". The behavior on methods…
Daniel Jones
  • 117
  • 1
  • 7
2
votes
0 answers

VS2015 fails in one specific keyboard shortcut

I'm using VS 2015 version 14.0.25425.01 update 3 with GhostDoc 5.1 installed. I use Ctrl+Shift+D to document properties or methods, this was working great until a week or so (I don't know if this has anything to do with the latest update to SSMS…
Juan Zamudio
  • 373
  • 11
  • 35
1
2 3 4