Coding Standards

The Problem

Teams nearly exploded over the discussion, where to put braces in the source code or in which manner attribute names should be selected.

On the other hand, it is a well accepted practice, that the use of uniform, consistent coding standards simplifies working on the source code. Finding the right balance is not easy, but necessary.

The Solution

As one of the 12 practices XP suggests having coding standards, which contain recommendations for the programmer with regards to

• how to lay out the code, e.g. tabbing, braces, comments
• where source code files should be located in the file system
• which settings should be used for the compiler and linker
• which naming conventions should be followed for files, classes, methods, attributes, parameters, and local variables.

For Java such a specification exists. For other programming languages this one can be adapted.

Tips

• Coding standards should be discussed and decided upon in the team.
• Coding standards are not part of the responsibilities of a corporate department
• Adjust your coding standards on a regular basis.
• Do not select coding standards disregarding what is already out there. If there is an accepted practice, please deviate only, where you have an excellent justification.