26.8 Reihenfolge der Eigenschaften in Klassen

Ein Grundgerüst für einen einleitenden Kopf einer Datei könnte wie folgt aussehen:

/*
 * @(#)Test.java
 *  Description: This is a test program
 *  Rev:         C
 *  Created:     Wed. June 25, 1997, 21:22:23
 *  Author:      Christian Ullenboom
 *  mailto:      C.Ullenboom@java-tutor.com
 *
 *  Copyright Universität Paderborn
 *  Warburger Str. 100
 *  33098 Paderborn - Germany
 *
 *  The copyright to the computer program(s) herein
 *  is the property of University Paderborn, Germany.
 *  The program(s) may be used and/or copied  only with
 *  the written permission of Paderborn University
 *  or in accordance with the terms and conditions
 *  stipulated  in the agreement/contract under which
 *  the  program(s) have been supplied.
 *
 *  CopyrightVersion 1.1_beta
 */

Anschließend folgt ein JavaDoc-Kommentar der Klasse.

/**
 * Blub macht alles vieles schöner.
 *
 * @author   <a href="mailto:C.Ullenboom@Java-Tutor.com">Christian Ullenboom
 * @version  1.2 12/03/2003
 */

Die Elemente einer Klasse lassen sich in verschiedene Sektionen aufteilen:

Klassenvariablen (statische Eigenschaften)

Objektvariablen

Konstruktoren

Methoden

Innerhalb eines Blocks werden die Informationen bezüglich ihrer Zugriffsrechte sortiert. Diese Angaben sollten im Quelltext in der Reihenfolge

public

protected

paketsichtbar (also ohne Sichtbarkeitsschlüsselwort)

private

angegeben werden. Der öffentliche Teil befindet sich deswegen am Anfang, da wir uns so schnell einen Überblick verschaffen können. Der zweite Teil ist dann nur noch für die erbenden Klassen interessant, und der letzte Teil beschreibt allein geschützte Informationen für die Entwickler.