Galileo Computing < openbook > Galileo Computing - Professionelle Bücher. Auch für Einsteiger.
Professionelle Bücher. Auch für Einsteiger

Java ist auch eine Insel von Christian Ullenboom
Programmieren für die Java 2-Plattform in der Version 5 (Tiger-Release)
Buch: Java ist auch eine Insel
gp Kapitel 26 Style-Guide
  gp 26.1 Programmierrichtlinien
  gp 26.2 Allgemeine Richtlinien
  gp 26.3 Quellcode kommentieren
    gp 26.3.1 Strategischer und taktischer Kommentar
    gp 26.3.2 Bemerkungen über JavaDoc
    gp 26.3.3 Gotcha-Schlüsselwörter
  gp 26.4 Bezeichnernamen
    gp 26.4.1 Ungarische Notation
    gp 26.4.2 Vorschlag für die Namensgebung
  gp 26.5 Formatierung
    gp 26.5.1 Einrücken von Programmcode – die Vergangenheit
    gp 26.5.2 Verbundene Ausdrücke
    gp 26.5.3 Kontrollierter Datenfluss
  gp 26.6 Ausdrücke
  gp 26.7 Reihenfolge der Eigenschaften in Klassen
  gp 26.8 Zugriffsrechte und Zugriffsmethoden
    gp 26.8.1 Accessors/Zugriffsmethoden
  gp 26.9 Verweise


Galileo Computing

26.7 Reihenfolge der Eigenschaften in Klassetoptop

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</a>
 * @version  1.2 12/03/2003
 */

Die Elemente einer Klasse lassen sich in verschiedene Sektionen aufteilen:

gp  Klassenvariablen (statische Eigenschaften)
gp  Objektvariablen
gp  Konstruktoren
gp  Methoden

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

gp  public
gp  protected
gp  paketsichtbar (also ohne Sichtbarkeitsschlüsselwort)
gp  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.





Copyright © Galileo Press GmbH 2004
Für Ihren privaten Gebrauch dürfen Sie die Online-Version natürlich ausdrucken. Ansonsten unterliegt das <openbook> denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.


[Galileo Computing]

Galileo Press GmbH, Gartenstraße 24, 53229 Bonn, Tel.: 0228.42150.0, Fax 0228.42150.77, info@galileo-press.de