![]() Is there any logical reason to auto-generate code documentation? Do you do this, and are there any rational reasons not to simply leave code undocumented if you aren't going to actually write the documentation yourself? It seems that the attitude with GhostDoc is, "it's intrinsically better to have some kind of formal XML documentation", but when that documentation is 100% redundant, why? Isn't it just wasting a ton of space at best?Īt my workplace, we have to document everything, and almost always with GhostDoc's auto-generated docs. Private void RichTextSelection_Changed( richTextBox). In the worst, it can actually end up generating bizarre documentation that is actually misleading in its attempt to heuristically figure out the meaning of names: /// / Initializes a new instance of the class. In the best case, it does what the reader could already do in their head (examples taken from here): /// and outputs English that might explain them more verbosely. It takes a look at names of methods, classes, etc. However, by definition, everything it generates is redundant. ![]() Automatic documentation generation can be done with a variety of tools, GhostDoc being one of the more prominent.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |