Writing Javadoc Comments
Javadoc comments are an advanced form of comments. The purpose of regular source code comments is to indicate to readers of your source code files what you're up to. The limitation here is obvious.
What if I don't wanna distribute my source code files? Even if I did, it's inconvenient and difficult to sort through all of the source code just to find out what a class' contract is.
Then you have to distribute documentation files separately. Duh.
But it's a draaaag to make separate documentation files. They get out of synch with my source code, and then they're worse than useless.
True. You're starting to sound a little whiney, dear, but these are good points. Javadoc addresses your concerns by providing a facility for generating ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access