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
2
votes
1 answer

What does GhostDoc Free do that Visual Studio does not already do?

I am trying to find a way to turn the comments I generate in Visual Studio using /// into HTML. It appears that GhostDoc Pro will do this for me. And all that GhostDoc Free will do, is generate the comments in Visual Studio. From what I can tell…
Evorlor
  • 7,263
  • 17
  • 70
  • 141
2
votes
1 answer

GhostDoc VisualStudio extension Load exception

I've formatted my harddrive to reinstall Windows 8 x64. After installing VisualStudio 2013 and then GhostDoc extension, in the moment that I try to run the VS IDE (an VB/C# project of any kind), it throws an exception related to GhostDoc that I…
ElektroStudios
  • 19,105
  • 33
  • 200
  • 417
1
vote
1 answer

Ghostdoc doesn't attempt to generate return information

I've noticed Ghostdoc never seems to attempt to produce returns documentation. Given a method like this: /// /// Gets the departure date. /// /// private DateTime GetDepartureDate() { // TODO: } I'd…
Robbie Dee
  • 1,939
  • 16
  • 43
1
vote
1 answer

Has anybody made a german config file for the GhostDoc AddIn?

Has anybody made a german version of the GhostDoc template textes?
ChaosSpeeder
  • 3,468
  • 5
  • 30
  • 38
1
vote
2 answers

Unable to install ghostdoc, can you help?

I am unable to install ghostdoc. The error message is "Microsoft Visual Studio.NET is not installed on your computer" Visual Studio is installed on my computer. Have you seen this problem? Is there a workaround? Is there a way to install ghostdoc…
user380719
  • 9,663
  • 15
  • 54
  • 89
1
vote
1 answer

Solving the XML doc comment dilemma

Regarding XML doc comments in C#-code there are two schools of thought: Robert C. Martin's Clean Code approach of "If you carefully name your classes, methods and variables to express the intent of your work, you don't need comments." You need to…
tobre
  • 1,347
  • 3
  • 21
  • 53
1
vote
1 answer

How do you add a blank commented line in T4 using Ghostdoc Pro in Visual Studio?

Inside of the "Rules" settings in GhostDoc Pro it allows me to use T4 to format my comments. However it randomly adds line breaks(which I have sorted out), and also will not allow me to add a single line of triple forward slashes. For…
JaeGeeTee
  • 513
  • 1
  • 6
  • 23
1
vote
1 answer

Using GhostDoc to generate Comments for attributes on properties

How can I configure GhostDoc to generate comments for attributes on properties such as this: [Required(ErrorMessage = "Name is Required.")] [StringLength(50, ErrorMessage = "Name must be less than 50 characters.")] public string Name { get; set; }
SetiSeeker
  • 6,482
  • 9
  • 42
  • 64
1
vote
1 answer

Ghost doc to add "modified by" comment

Is there a way to get ghost doc to modify an existing XML comment for a method (made by Ghost doc) to add a "modified by" line when you re run it on the method? I personally think this is what source control is for, but they want to do it in the…
Eric Brown - Cal
  • 14,135
  • 12
  • 58
  • 97
0
votes
1 answer

Move GhostDoc documentation to tag file

So I have GhostDoc Pro and auto documented a project. Great. The results are, as it says in the C# documentation put it all together verbose compared to the code. Therefore I would like to use the include tag and a separate file for the…
rupweb
  • 3,052
  • 1
  • 30
  • 57
0
votes
1 answer

GhostDoc how to get attributes of a property?

I use the aforesaid documentation tool on Visual Studio 2017. I can reach the GhostDoc Options > Rules > Property Template and customize the code. I have a property like; [Display(Name="Text here")] [Required] public int CompanyId {get;set;} I want…
sulhadin
  • 521
  • 4
  • 16
0
votes
1 answer

Ghostdoc 'document this' shortcut not working

I'm using Visual Studio 2017 Community Edition V15.8.4 and the latest Ghostdoc version available in the Marketplace (Build 2018.1.18330). Since the last update, Ghostdoc no longer recognizes any assigned shortcut. Whenever any shortcut other than…
devlock
  • 959
  • 1
  • 9
  • 14
0
votes
0 answers

What do brackets mean in C# xml documentation generated by ghost doc?

I generated xml-comments to a method with Ghost doc /// /// Determines whether [is lv class identifier] [the specified class identifier]. /// /// The class identifier. ///…
char m
  • 7,840
  • 14
  • 68
  • 117
0
votes
1 answer

GhostDoc "Document this" not working for method with attribute

I am using GhostDoc and Visual Studio 2017. Now, if I have a method like this public string Foo() { ... } I can normally use GhostDocs "Document this" to generate an XML comment for the relevant method. However, if the method has any attributes…
Thomas Flinkow
  • 4,845
  • 5
  • 29
  • 65
0
votes
1 answer

How can I get GhostDoc to properly document interface implementation?

I used Ghostdoc Free, a year ago in Visual Studio 2015, and really liked what it did, and decided to purchase it. I now have to use Visual Studio 2012 and noticed that comments for classes are not as good as before. It now just says: /// The…
reckface
  • 5,678
  • 4
  • 36
  • 62