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 It" for the whole file, not just one member at a time. Is it possible?

+2


source to share


3 answers


Not. I still love him regardless.



+1


source


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

(This was a deliberate design choice in Atomineer and presumably also in GhostDoc, because it is generally a bad idea to document everything automatically and move on. Both of these add-ons provide a reasonable starting point for documenting the 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 change the final comment If you automatically generate the entire set of documentation then the docs are pretty bad because they do little more than describing what the code element names already represent ).

However , both add-ons 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 formatting options of AtomineerUtils
  • (in both additions) To quickly add skeleton documentation to a class

In all of these situations, it is highly recommended to view the resulting comments, but automating the update saves a lot of time.

+2


source


0


source







All Articles