Java Getriebe

Java und NetBeans

Wie schreibt man ein gute JavaDocs

Eine Frage dich ich nicht wirklich zur Zufriedenheit beantworten kann. Allerdings bin ich der gleichen Meinung wie Adam Bien, dass man sich solche Kommentare sparen kann:

1
2
3
4
5
6
/**
 * This is a setter which sets the name
 *
 * @param name - the name to be set
 */

public void setName(String name) {...

In den Kommentaren zu oben verlinktem Artikel wurden einige Vorschläge gemacht, was Adam zu einem weiteren Artikel veranlasst hat in dem noch mehr Kommentare verfasst wurden. Insbesondere ein Kommentar von Kai Windmöller beinhaltet einen sehr netten Merksatz zum Thema Dokumentation:

Put
the WHAT in the name,
the HOW in the code, and
the WHY in the comment.

Da bleibt mir eigentlich nichts mehr hinzuzufügen.

One Response to Wie schreibt man ein gute JavaDocs

  1. Elmar says:

    Guter Merksatz. Was ich praktisch finde sind die @NullAllowed-Annotations (org.netbeans.api.annotations.common) in NetBeans. Dann gibt es nicht nur Hints für potenzielle NullPointerException sondern beim Aufrufen der Javadoc – ob vorhanden oder nicht – mit Strg+Leer zeigt mir diese Annotation und ich weiß, dass ich problemlos null überreichen kann.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.