CODECUBE VENTURES

Worthless Documentation

You know, tools like NDoc (http://ndoc.sourceforge.net/) and Doxygen (http://www.stack.nl/~dimitri/doxygen/) are awesome for automatically generating documentation. Unfortunately, many times we see documentation that's nothing more than an object model browser with little to no explanatory text about the documented code, and much less examples of it's use.

If I wanted to see a list of methods and properties, I could use reflector (for .net), or browse the .h file (for C++) documentation without examples should be outlawed. I credit the MSDN documentation (and other Microsoft docs) for almost always having example usage code.

Latest post: Digging Up the First Version of CodeCube

See more in the archives