Als «jsdoc» getaggte Fragen

JSDoc ist eine Auszeichnungssprache zum Hinzufügen von Inline-API-Dokumentation zum JavaScript-Quellcode. Dies unterscheidet sich von den verschiedenen Tools, die Code analysieren und bearbeiten, der der JSDoc-Syntax folgt.

6
Wie beschreibe ich "Objekt" -Argumente in jsdoc?
// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Aber wie beschreibe ich, wie das Parameterobjekt strukturiert sein soll? Zum Beispiel sollte es so etwas sein wie: { setting1 : 123, // …
316 javascript  jsdoc 




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" …




4
Wie kann ich in JsDoc void zurückgeben?
Gibt es eine bestimmte Möglichkeit, eine Methode oder eine Funktion zu deklarieren, um in JsDoc void zurückzugeben? Derzeit bin ich der Überzeugung, dass dies voidder Standardrückgabewert ist, und andere Rückgabewerte müssen speziell angegeben werden: /** * @return {Integer} The identifier for ... */
80 javascript  ide  jsdoc 

2
Wie dokumentiere ich ein Wörterbuch in JSDoc?
Mit dem nächsten Beispiel: var CONF = { locale: { "en": { name: "English", lang: "en-US" }, "es": { name: "Spanish", lang: "es-ES" } } }; Und wenn ich weiß, dass die Eigenschaft locale ein Wörterbuchobjekt enthält, das aus der Datenbank stammt, wie kann ich seine inneren Eigenschaften mit JSDoc …

4
Wie kann man Rückrufe mit jsdoc richtig dokumentieren?
Ich habe eine ganze Weile im Internet nach dem besten Weg gesucht, Rückrufe mit jsdoc richtig zu dokumentieren, aber leider habe ich noch keinen großartigen gefunden. Hier ist meine Frage: Ich schreibe eine Node.js-Bibliothek für Entwickler. Diese Bibliothek bietet mehrere Klassen, Funktionen und Methoden, mit denen Entwickler arbeiten werden. Um …


Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.