Coding Standards

Sun Microsystems introduces its coding conventions with a discussion of the utility of such standards:

• 80% of the lifetime cost of a piece of software goes to maintenance.
• Hardly any software is maintained for its whole life by the original author.
• Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly.

The Streek project follows Sun's coding conventions.

Streek developers, using the Eclipse IDE and the Jalopy plugin, maintain consistent code formatting without need for individual concern about these critical but - in the heat of the coding moment - distracting matters.

Streek's cannonical coding style is published as (functionally identical) binary and xml-encoded Jalopy configuration files in the ist-jxde tree (after checking ist-jxde out of CVS, cf. the jalopy/ directory). In Eclipse, this configuration (in its XML-encoded form) can be imported from the General pane of the Jalopy Preferences dialog. To reach the Jalopy Preferences dialog, open any .java file in Eclipse and choose from the Window menu.