Menu

The Best Way To Document The API

I've recently discovered what my JavaDocs look like and I'm tempted to halt all development until they're fixed.

That's not going to happen tho, because fixing them will be another endless task. So I'm doing them as I find them, in quiet moments say or will chatting to friends etc.

However the real question is what constitutes a good JavaDoc?

Is it short and pithy, or long and detailed? With lots of references or self-contained?

In all the years I've been coding I haven't real done any JavaDocs and I always find other API's docs tediously out-of-date so I dismissed them as useless.

Now that I realise they are the only reliable way to communicate with distant programmers, I'm feeling a little under-skilled.

I'm trying to improve them but does anyone have some good references or, better yet, want to do them?

Posted by Gregory Graham 2014-01-30

Anonymous
Anonymous

Add attachments
Cancel





Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.