• Java 2 JDK 1.4 (http://java.sun.com/)

• Apache Ant (http://jakarta.apache.org/ant)

  Ant sollte auf einem Linux/Unix/OSX System möglichst mit Hilfe der Paketverwaltung installiert werden.

• CVS - The definitive CVS documentation unter http://cvsbook.red-bean.com/cvsbook.html)

  Für Win32 kann wincvs von http://www.wincvs.org eingesetzt werden.

  Bei Mac OSX befindet sich die CVS-Software auf der Entwickler-CD, welche kostenlos bei Apple heruntergeladen werden kann.

Voraussetzungen:

• Java 2 JDK 1.4 (http://java.sun.com/)

• Apache Ant (http://jakarta.apache.org/ant)

• Jmol Quellcode

• Der gewählte Editor sollte Zeilen automatisch einrücken. Falls er das nicht tut und sich dieses Feature auch nicht aktivieren lässt, sollte ein anderer Editor benutzt werden.

• Die Breite der Einrückung (Tabulatorbreite) soll zwei Leerzeichen betragen.

    class Foo {
      int someClassVariable;
      
      Foo(int evenOrOdd) {
        someClassVariable = 99;
      }
      
      ...
    }
          

• Statt Tabulatoren sollten Leerzeichen benutzt werden

• Zuweisungen und arithmetische Operatoren besitzen i.A. auf beiden Seiten Leerzeichen.

    a = b + c;
          

  Es ist erlaubt, die Leerzeichen zwischen Ausdrücken zu entfernen, um die Operator-Priorität zu verdeutlichen.

    int cSquared = a*a + b*b;
          

• In der Liste der Argumente folgt auf ein Komma ein Leerzeichen.

    foo(a, 3.14159, "jmol");
          

• Eine Zeile sollte nicht länger als 80 Zeichen sein.

• Öffnende Klammern befinden sich in der Zeile, die den Block öffnet. Schließende Klammern werden in eine eigene Zeile geschrieben.

    if (condition) {
      ...
    } else {
      ...
    }
    
    while (condition)
      ...
    }
          

• Schleifen werden bei 0, nicht bei 1 gestartet.

• Nur < und >= sind valide Vergleichsoperatoren zur Termination von Schleifen ... alles andere ist möglicherweise fehlerhaft. Falls nicht absolute Gewissheit besteht, dass das Gegenteil der Fall ist, sollte in diesen Fällen ein Kommentar im Quellcode hinterlassen.

• Variablen- und Methodenbezeichnungen müssen eindeutig und beschreibend sein. Nur keine Hemmungen bei langen Bezeichnungen.

• line-by-line Kommentare sind unerwünscht ... in speziellen Fällen kann es Ausnahmen geben. Falls sich viele soclhe Kommentare im Quellcode finden, könnte es passieren, dass sie einfach gelöscht werden.

• Falls Kommentare unbedingt notwendig sind, sollten sie als JavaDoc vor der Funktion eingefügt werden

• Kommentare sollten nicht in Code eingefügt werden, der gerade verändert wird. Schlechte/veraltete Kommentare sind schlimmer als gar keine Kommentare.

• Empfehlenswert ist auch ein Blick in The Elements of Java Style von Vermeulen, et al.

• Debian (Daniel Leidert & Egon Willighagen)

• RPM (Miguel Howard)