3

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
  • I did not re-install ghost doc on my recently acquired machine. I tried it. Didn't like it. R# did a better job of "ghost writing" the generic comments AND they pass stylecop formatting. – No Refunds No Returns Jan 06 '10 at 22:56
  • You can actually do that now with GhostDoc Pro - it introduces Document File, Document Type commands and flexible T4 based comment templates – sergeb Apr 27 '11 at 20:24
  • You can't use GhostDoc to add documentation, period. All it does is add pointless file size. – HiredMind Feb 11 '17 at 03:29

3 Answers3

3

When I originally answered this question, this was not possible in GhostDoc, or in my (similar) addin, Atomineer Pro Documentation).

(This was an intentional design choice in Atomineer, and presumably also in GhostDoc, because it's a generally bad idea to document everything automatically and move on. Both these addins produce a reasonable starting point for documentation of a method, and sometimes they will provide good enough documentation that you don't need to make any adjustments - but most of the time you will want to tweak the resulting comment. If you auto-generate the entire documentation set, then the docs will be pretty poor, because they will do little more than describing what the code element names already state).

However, both addins now now provide this feature, which is very useful in the following situations:

  • (in Atomineer) To batch-convert legacy comments between JavaDoc, Doxygen, Qt and XML Documentation formats
  • (in Atomineer) To update the style/layout of documentation comments after changing the AtomineerUtils formatting options
  • (in both addins) To quickly add skeleton documentation to a class

In all these situations it is strongly recommended that you review the resulting comments, but automating the update does save a lot of time.

Jason Williams
  • 56,972
  • 11
  • 108
  • 137
  • "sometimes they will provide good enough documentation that you don't need to make any adjustments" Based on my experience using GhostDoc and using libraries "commented" with it, I think instead of *sometimes* you meant to say *never*. – Ryan Lundy Nov 11 '09 at 20:36
  • Two things. 1) it IS possible in GhostDoc now, and 2) it would be good to state that you are the developer of AtomineerUtils – Chase Florell Feb 29 '12 at 23:00
  • @ChaseFlorell - You're quite right on both counts. I normally do try to make that clear. I've edited mny answer to bring it up to date with recent developments. – Jason Williams Jul 11 '12 at 19:23
1

No. I still love it also regardless.

Keith Adler
  • 20,880
  • 28
  • 119
  • 189
1

Use document File Option:

enter image description here

see the comment added for all members within the file:

enter image description here

sashoalm
  • 75,001
  • 122
  • 434
  • 781
Pranav Mishra
  • 456
  • 2
  • 7
  • 14