devgrind

If you are documenting Java methods, try to fit everything really important (like constraints for the method) into the first sentence of the javadoc. This sentence is displayed along wiht the overview of the class method.

Everything after the first sentence vanishes in the distance where no-one will ever read it.

Filed by Magnus at 5:24 pm under documentation, java, programming
No Comments.