Ich weiß, dass dies nicht das wichtigste Problem ist, aber ich habe gerade festgestellt, dass ich den Javadoc-Kommentarblock vor oder nach der Anmerkung einfügen kann. Was möchten wir als Codierungsstandard übernehmen? /** * This is a javadoc comment before the annotation */ @Component public...
Wie kann ich JSDoc über die Struktur eines zurückgegebenen Objekts informieren? Ich habe die @return {{field1: type, field2: type, ...}} descriptionSyntax gefunden und ausprobiert: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid...
Ich habe eine Funktion, die einen String-Parameter akzeptiert. Dieser Parameter kann nur einen von wenigen definierten möglichen Werten haben. Was ist der beste Weg, um dasselbe zu dokumentieren? Sollte shapeType als enum oder TypeDef oder etwas anderes definiert werden? Shape.prototype.create =...
Für jede Klasse im Projekt erstellt SandCastle (unter anderem) zwei Seiten: Die Hauptseite T_class_full_namemit der Beschreibung Syntax, Vererbungshierarchie und Siehe auch Die Mitgliederseite AllMembers_T_class_full_namemit Konstruktoren, Methoden, Feldern usw. Gibt es eine Möglichkeit,...