Prof. Dr. Pape - Java Programmierrichtlinien - Javadoc |
Deutsch | |||
Javadoc - AttributeZurück zur ÜbersichtBeschreibe die Bedeutung der Werte
Beispiel/** Eine deutsche 5-stellige Postleitzahl. Es sind nur gültige Postleitzahl aus dem offiziellen Verzeichnis der Post erlaubt. */ private int postleitzahl; /** Der Verkaufspreis in Euro. Er darf nicht negativ sein. */ private double verkaufspreis; /** Der obligatorische Hauptwohnsitz. Er darf nicht null sein. */ public Adresse hauptwohnsitz; BegründungAttribute enthalten Daten. Um ein Attribut zu verstehen, muss deutlich werden, was dessen Daten bedeuten. Am besten fragt man sich selbst, was die Werte bedeuten sollen: Was bedeutet 7 bei der Variablen, was -12? Dürfen überhaupt negative Zahlen vorkommen beim Attribut? Grundsätzlich ist es bei primitiven Datentypen deswegen auch sinnvoll zu beschreiben, ob alle Werte aus dem Wertebereich angenommen werden dürfen. Bei Referenztypen sollte immer auch beschrieben sein, ob null ein erlaubter Wert ist: in diesem Fall aber auch die Bedeutung von null beschreiben. |
||||
|   |   |   |