Ich habe oft ein Dilemma, wenn ich Javadoc für Eigenschaften / Mitglieder einer "einfachen" POJO-Klasse schreibe, die nur Eigenschaften und Getter und Setter enthält (DTO-Stil) ....
1) Schreiben Sie Javadoc für die Eigenschaft
oder ...
2) Schreiben Sie Javadoc für den Getter
Wenn ich Javadoc für die Eigenschaft schreibe, kann meine IDE (Eclipse) dies (natürlich) nicht anzeigen, wenn ich später über die Code-Vervollständigung auf das POJO zugreife. Und es gibt kein Standard-Javadoc-Tag, mit dem ich das Getter-Javadoc mit der eigentlichen Eigenschaft Javadoc verknüpfen kann.
Ein Beispiel:
public class SomeDomainClass {
/**
* The name of bla bla bla
*/
private String name;
/**
* @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc
*/
public String getName() {
return name;
}
Grundsätzlich wäre es also interessant zu hören, wie andere vorgehen, damit Ihre Eclipse-IDE die Beschreibung der Javadoc-Eigenschaften für Ihre Getter anzeigt - ohne den Javadoc-Kommentar duplizieren zu müssen.
Ab sofort denke ich darüber nach, in meiner Praxis nur die Getter und nicht die Eigenschaften zu dokumentieren. Aber es scheint nicht die beste Lösung zu sein ...