Skip to main content

Stephen Colebourne: Javadoc coding standards

Javadoc coding standards: Javadoc is a key part of coding in Java, yet there is relatively little discussion of what makes good Javadoc style - a coding standard. These are the standards I tend to use when writing Javadoc. Since personal tastes differ, I've tried to explain the rationale for some of my choices. Bear in mind that this is more about the formatting than the content of Javadoc...

Community: General