Java Coding Standards

In this class, we will follow Java's official code conventions. You must document your classes and methods with JavaDoc comments.

ICS's Java Coding Standards

For this course, you must follow the guidelines given in this document, which is a subset of Java's offical code conventions.

Exceptions/Clarifcatons/Additions:

• You do not need to provided version control comments.
• You may put either one or two blank lines between method definitions.
• You may indent either 2, 4, or 8 spaces; you may use either tabs or spaces. Whatever you choose, you must be consistent!
• Lines should not exceed 80 characters in length.

Code Conventions for the Java Programming Language

These are Java's official code conventions. They are more extensive than those standards given above. You are strongly encouraged to read this document and format your code accordingly.

More on Documenting With JavaDoc

Briefly, what to write and how to turn your comments in to API-like HTML.

Example Code: HelloWorld.java

You can see the generated JavaDoc documentation for this file. Also, here is a bad example of following the coding standards.