Whooo, Javadoc

Monday, May 11th, 2009 12:19 pm
afuna: Cat under a blanket. Text: "Cats are just little people with Fur and Fangs" (Default)
[personal profile] afuna
The one thing I love about JavaDoc is that it starts with two stars. Makes it look special (and, in Eclipse, blue).

The things I don't like about JavaDoc are too many to count! But the list includes annotations! Why are you letting comments define behavior? That's just freaky.

On the flip side, documentation is a good warm up to the day, so!

Date: 2009-05-11 11:18 pm (UTC)
owl: The Articles of War are not "More actual guidelines than rules." - Captain Sir Edward Pellew, RN (articlesofwar)
From: [personal profile] owl
Hmm, I've just realised that I think of JavaDoc comments in a slightly different way than I do about normal comments, that they're more codey or something. I'm sure our tech lead would be glad to hear that, as he tears into JavaDoc with the same persistence as he does into code, but a block comment will only get an eyeroll unless it's on a [livejournal.com profile] whitaker's-mom level.

Date: 2009-05-14 08:26 am (UTC)
owl: Motherboard and CD (computer)
From: [personal profile] owl
Yes, that is his point. However, in the middle of the code review he said thoughtfully, "You know, we really should generate this JavaDoc one of these days..." :D