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.

316
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:...

80
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...

74
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...