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

Ghostdoc creates a help folder, but no .chm file

I have installed Ghostdoc enterprise and the visual studio 2017 extention. I have installed htmlhelp. Every time I build help documentation, either through cmd or through visual studio itself, a help folder is created, but that folder is empty,…
0
votes
1 answer

XML documentation: using "cref" in , is this acceptable or not necessary?

I am using GhostDoc to document my methods etc... and its working well but it doesn't fill the ... Can anyone tell me what i should be doing i.e If it returns an object called "Roles" then A role object see
Martin
  • 23,844
  • 55
  • 201
  • 327
0
votes
1 answer

Can I get a report on missing XML documentation

I am trying out GhostDoc, StyleCop, CodeIt.Right, FXCop etc to find a streamlined way of adding both autogenerated XML-Comments in C# code as well as updating existing comments in case parameters changed for example. GhostDoc Pro seems to work…
Peter Andersson
  • 1,947
  • 3
  • 28
  • 44
0
votes
2 answers

GhostDoc public const documentation

When using ghostdoc on single line vars defs like public const string DbCatName = "test"; ghostdoc adds a default header like : /// /// /// but what I like to have is /// Does anybody know how to do…
Marcel de Kleine
  • 146
  • 1
  • 11
0
votes
1 answer

How can I only document a subfolder with GhostDoc?

I am trying to build a HelpFile in GhostDoc. It only gives me the option to document entire Projects. I only want to document a sub folder within a project. How can I do this? I see no options to select a subfolder. If I right click on a…
Evorlor
  • 7,263
  • 17
  • 70
  • 141
0
votes
1 answer

Process custom xml elements in xml document code comments for MSDN style Help files

I am looking for a way to build Help files that include custom XML elements for a large project. I want to add my own element similar to the Summary element and have the help files include it. I have Sandcastle and Ghost Doc Pro installed. I have…
SimperT
  • 2,837
  • 2
  • 15
  • 19
0
votes
1 answer

Ghostdoc not handling upper case constants with underscores correctly

Ghostdoc seems to get massively confused when encountering a const that contains underscores. Leaving aside whether constants should be in this format, it seems to me that this could be handled better. I've supplied an example below: Aside from…
Robbie Dee
  • 1,939
  • 16
  • 43
0
votes
1 answer

GhostDoc Context.CurrentCodeElement.HasBaseTypes always returns false

Any ideas on how to get base types of a class using Ghost Doc? Depending on the base class the current class inherits from, I want to customise the summary comment of the current class. This is what I have so far: private string…
c0D3l0g1c
  • 3,020
  • 5
  • 33
  • 71
0
votes
1 answer

Add Login to GhostDoc generated help website

I have a project with XML comments all set up and the documentation is being generated as expected but my boss would like to put the documentation itself behind a log in so its not freely accessible. Is this something I could do by adding a landing…
Mike_OBrien
  • 1,395
  • 15
  • 34
0
votes
1 answer

How to stop GhostDoc adding punctuation to the end of the line

Whilst there is a lot a like about GhostDoc, I've never liked the fact that it adds a full stop to the end of each comment in the tag. Is there a hack to turn this off? I say "hack" as I've already checked the options and I can't see anything that…
Robbie Dee
  • 1,939
  • 16
  • 43
0
votes
0 answers

Can I configure ghostdoc to generate javadoc type of comment header for c++ codes

Is there anyway to configure ghostdoc to generate javadoc type comment head for c++ classes and function? I am using GhostDoc inside visual studio and I like to generate javadoc type of comments, but ghostdoc generate xml type of comments. Is there…
mans
  • 17,104
  • 45
  • 172
  • 321
0
votes
1 answer

C# Comment Template

Would anyone happen to know if you can make a custom template for comments in c#? I use a modification of the RME style of commenting instead of the section. Unfortunately, I don't have a ghost doc pro subscription. I would like it to work just…
0
votes
1 answer

How to document a file that is not in a solution?

I have a need to document methods/functions in *.cpp code files that are not part of a .NET solution. Up until now my workaround has been to create a solution, but this is a time consuming step for all the different files I come across. Does anyone…
0
votes
1 answer

Remove first parameter character with GhostDoc

I have paramters named like pOtherColor. Using ghostdoc I get "The p Other Color". The Macro is $(Name.Words.TheAndAllAsSentence) There is a macro ExceptFirst - but this gives "Other Color". What I would need is a macro like…
ManniAT
  • 1,989
  • 2
  • 19
  • 25
0
votes
1 answer

Using cref in class description with GhostDoc

I just started using GhostDoc, so I hope mine is not a stupid question. I want to document Class1 by referring to its method Method1. So, I use cref in the description of Class1 as follows. /// /// Use this class to do a lot of things. ///…
user3537808
  • 103
  • 1
  • 7