Java Coding Standards

Java coding conventions

In general, we follow the Google conventions for Java code, as documented here: https://google.github.io/styleguide/javaguide.html

In general, we follow the Oracle standards for javadoc comments as documented here: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

Differences with the Oracle standards:

@author Your Name (your github-id), include multiple authors as appropriate
@version - omit
@param - when not obvious, try to help IDEs display hints
@return - when not obvious, try to help IDEs display hints
@exception or @throws - for clarity when runtime exceptions are possible
@see - as appropriate
@since - required, just the number (e.g., 8 or 15)
@serial - as appropriate
@deprecated - include an explanation of what to do in place of the deprecated functionality

It is not necessary to use javadoc in test code.