Hacker News new | ask | show | jobs
by edwinnathaniel 4511 days ago
Writing "proper" javadoc takes time. It has tons of keywords and annotation to make it look consistent like any other "professional and good looking" javadoc out there.

For example: if one is deprecating a method, there are a bunch of proper JavaDoc ways to do this (starting with the @deprecated annotation, not to be confused with another @Deprecated annotation, don't forget to state since which version this method is deprecated, etc etc).

It requires a high level of discipline and knowledge of the javadoc idioms.

http://www.oracle.com/technetwork/java/javase/documentation/...

Occasionally, one have to insert HTML too...

I know C# support similar thing.