Question

The whole point of GhostDocs is obviously to document your code. It asks you to name your methods well to do so. With well named methods however, theoritically shouldn’t they be useful enough to be considered documentation?

I just want to hear some pros/cons of current users as I don’t want to download it and clutter up my code with unnecessary and duplicating documentation.

Answer 1

While self-documenting code helps, if it were all you needed nobody would ever consult MSDN (which is, by the way, an expanded, language-merged HTML form of the XML documentation in the .NET libraries themselves).

XML-doc comments allow you to describe classes, methods, parameters, and other members more verbosely than you’d ever want to do with an identifier. You can recommend best practices, discourage incorrect or “hack-y” uses of your code, detail what could go wrong and why, etc etc. This information is available when your source code isn’t (if you compile it properly), and is invaluable when your code isn’t quite as self-documenting as you think (many things you might think obvious are because you think a certain way, and not everybody will think the same way).