I’m working on a project right now that has near 99% of its code commented. Wow, that’s impressive! Actually, it’s more scary…even some of the private fields are commented…. At one point, someone decided that it was a good idea to impose some kind of standard rather than none, so they recommended StyleCop with all of its default settings, including requiring comments on everything. This seemed like a good idea, and it probably was, until someone found GhostDoc. The plugin definitely gives off that “cool” factor the first time you use it. Wow, with a single key stroke it automagically documented all of my code!!! The problem, and it’s a pretty big one, is that it generates documentation based on the name of the properties, names, and class. Surely if it can do that, you, a much more sophisticated machine, can do that!
Read on...