Introduction

The purpose of this document is to examine Java coding standards and conventions used throughout industry and to indicate the standards we adopt and practice.

Coding standards have existed in software development from day one as an attempt to aid program comprehension.

XP adovcates evolving your coding standards and involving the whole team. Within this coding standard document, we take this evolving approach and will try to communicate as best we can the reasons for adopting a given standard.

Why Have Code Conventions

The code is very important to us as it is it that is turned into 'working software'.

When it comes to software we value: * Working software: the software meets the customer expectations in terms of functionality and quality * Maintainable software: its easy to coprehend and make changes to the software

Thus we value and want to encourage code with the following properties: * Readable/Understandable * Simple as possible

Because of this we believe that practising code standards and conventions can help towards our ultimate goal of working software.

Other Java Coding Standards and Language Guides

• http://java.sun.com/docs/codeconv/'>Sun Java Conventions (1999)
• http://www.ambysoft.com/essays/javaCodingStandards.html'>Scott Ambler (2000)
• http://gee.cs.oswego.edu/dl/html/javaCodingStd.html'>Doug Lea (2000)
• http://java.sun.com/docs/books/effective/chapters.html'>Effective Java Edition 1
  • http://wiki.glassfish.java.net/attach/JavaProgramming/ej.html'>Online Companion
• http://java.sun.com/docs/books/effective/'>Effective Java 2nd Edition
  • http://www.infoq.com/articles/bloch-effective-java-2e'>infoq review

see the JavaCodingStandardsMatrix