5
Angesichts der folgende Code-Schnipsel:Javadoc Kommentare für einfache Konstruktoren. Benötigt oder unnötig?
/**
* Initializes a new instance.
*
*/
public Collector() {
this.map = new HashMap<>();
}
Bitte konzentrieren sich auf die Javadoc-Kommentar: Es gibt nicht sehr viel in diesem Konstruktor geschieht. Also, was ist der richtige Weg, um Javadoc dafür zu schreiben? Wie oben gezeigt? Das wäre vollkommen genau aber überflüssig zur gleichen Zeit, weil ein Konstruktor eine neue Instanz initialisieren soll.
Also, einerseits wollen wir keine überflüssigen Informationen in Javadoc-Kommentare schreiben, andererseits muss es einen Javadoc-Kommentar geben (oder?).
Also, kurz gesagt, wie man sinnvolle, nicht redundante Javadoc in solchen Situationen schreiben?
Ich hätte lieber einen * Javadoc-Kommentar * der wie folgt lautet - * Die Klasse X hat nur einen Standardkonstruktor, der eine HashMap HM initialisiert, die den Schlüssel k und den Wert V für die Operation speichert. O * – TheLostMind
Direkt von Oracle - [Dokumentieren von Standardkonstruktoren] (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#defaultconstructors). –
Wenn der Kommentar genau das ist, was Sie gepostet haben: Ich würde gerne den Typen sehen, der nicht weiß, dass ein Konstruktor eine neue Instanz initialisiert, aber schlau genug ist, das JavaDoc zu überprüfen. – Stultuske