Why Read This Document?

When a J2EE project is not performing fast enough or some bugs can not be found a code audit is often performed. The first question asked is "Does the company use any Java coding conventions?" Many companies have a coding conventions document but when you then look at the code nobody within the team has followed the conventions.

So why bother writing another convention document that will only collect dust on a shelf of an IT manager or developer?

• First of all this document does not only cover Java and J2EE coding conventions, but documentation, naming conventions, guidelines and best practices. In chapter 3 we'll even cover how to design an enterprise Java application using today's available Java technology stack.

• Secondly these conventions can be enforced by using existing Java tools. By enforcing these conventions we'll make a better developer out of you and hopefully we'll all produce better Java and J2EE code!

• Thirdly, and most importantly, this document was only possible through the support of the Flemish government and the Federal ICT (FEDict) department. The result is that Java and J2EE projects executed for these departments can follow and enforce the conventions written in this document!

Why Should You Read This?

People who want to introduce Java or Enterprise standards within their company should read and use this document.

If you're a senior Java or Enterprise developer then skip chapters one and two and focus on the design and appendix which lists the different rules.

If you're replying to a Request For Proposal (RFP) from either the Flemish government or FEDict then focus on the conventions and guidelines chapters, including the rules (with priority [enforced] and [high]) described in the appendix.

Conventions Used In This Document

Throughout this document you will find tips and notes.

Tip A tip is a helpful hint from the author.

Note A note needs to be observed carefully by the reader.

Each rule in this document has a reference number, for example [JAN_001] refers to the Java Naming Conventions number 001. During manual (or even automatic) auditing reviews you can use this reference within your own audit report.

Typographical Conventions

Class names are displayed like ClassName, method names like methodName, variables like variableName and literals like literal.

The Java code examples included in the rules are kept small, often not including the JavaDoc tags, to keep the examples readable and short.

Directory separators are displayed as { / }

Post Your Comments

Every wiki page allows you to post comments. Your suggestions or ideas on the selected section or rule are always very welcome.
If interested you could also get permission to update pages but at first I suggest you post comments.

More Information

A PDF version of each page can be created using the upper-right PDF icon.

In Bibliography you'll find more information on very interesting books and articles that were consulted.