Programmierung code-documentation

5

Codestyle; Javadoc vor oder nach der Annotation setzen?

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 class MyClass { @Autowired /** * …

183 java coding-style annotations javadoc code-documentation

3

JSDoc: Objektstruktur zurückgeben

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 mouse or touch event or a jQuery …

143 javascript documentation-generation jsdoc code-documentation jsdoc3

5

So dokumentieren Sie einen Zeichenfolgentyp in jsdoc mit begrenzten möglichen Werten

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 = function (shapeType) { // shapeType can be "rect", "circle" …

90 google-closure-compiler google-closure jsdoc code-documentation

1

Ist es möglich, zwei von SandCastle erstellte Seiten zu einer einzigen Hauptseite zusammenzuführen?

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, diese beiden zusammenzuführen - mit dem members pageAnhängen an die Hauptseite?

68 .net sandcastle code-documentation

Als «code-documentation» getaggte Fragen