The “Break it Down” Blog

A Tip for Writing Better Javadoc

Writing good Javadoc is hard enough as it is; getting the descriptions just right, explaining enough of the API to make it clear without imposing implementation guidelines on implementors, etc. One thing I’ve been doing for the last few years to make my Javadoc actually look better is trying to be better about using <code></code> tags [...]

Continue reading...