Introduction

Introduction

Overview and Scope

This document presents Java version of coding guidelines that is obligatory for all Itransition software development processes.

All details about development for other platforms are placed in separate documents. Platform independent information (like scripts development, graphical resources development) is stored in separate document.

Targeted Readers

Targeted readers for the document are all Itransition Java developers.

Typographical Conventions

The following special typographical conventions are used within the document:

Naming conventions

Introduction

A consistent naming pattern is one of the most important elements of predictability and discoverability in a managed source code. Widespread use and understanding of these naming guidelines should eliminate many of the most common user questions. This section provides naming guidelines for the different types of entities used.

All identifiers should be written using only proper English words. Avoid too sophisticated words. Do not misuse words. Try to find the simplest and most correct word. Usually you should write “Unique”, but not “Extraordinary”.

The major goal of all conventions is high level of code understandability and maintainability. If you feel that conventions violation can increase understandability in some particular case, you can do that. But think twice before.

Do not use language specific naming. Do not create language-specific method and parameters names, as in the following example:

void write(double doubleValue);

void writeDouble(double value);

Use instead:

void write(double value);

Avoid using names that duplicate commonly used Java packages and classes. For example, do not use any of the following names as a class name: Object, String or Exception. See Java API for a list of standard packages and classes.

It is not recommended to use the same packages and classes names, which are coming with frameworks and libraries, used in a project.