Javadoc was the revolutionary documentation tool that Sun themselves used to generate documentation for its API. Brilliant idea of the comment /** */ that anybody can use to generate their own documentation.
Ok, later on that annotation thing @ got into java and alas annotation has got into the language and (polluted the simplicity of Java since 1.5.
On the Microsoft programming world there is MSDN. Sure MSDN, contains a lot of info but it is inferior compared to javadoc in presentation quality. Javadoc is so clear about what's in a package, and what are the fields, methods of a particular class.
MSDN has that too but isn't so clearly layed out. (Javadoc wins)
Most of MSDN has sample code too, but yikes, sometimes those are too long and too complex to demonstrate a concept, sometimes the sample code is incomplete, formatted incorrectly and just too big too wild.
Ok, java API lacks sample code, but you can almost google any Java thing in question for an example.
When Microsoft copies Java into C# how come it doesn't copy this useful feature?
* * *
Waita minute, C# actually can generate documentation, but not good old HTML but XML.
(Did I say how much I hate XML?)
Here is the MSDN documentation. Some of the links on this page are BROKEN!
Look for /doc for documentation generation.
The world's biggest software monopoly can't even maintain its own documentations.
No comments:
Post a Comment