Programmierung jsdoc

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

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

4

Wie kann angegeben werden, dass param mit Inline-JSDoc optional ist?

Laut dem JSDoc-Wiki für @param können Sie angeben, dass ein @param optional ist /** @param {String} [name] */ function getPerson(name) { } und Sie können einen Parameter inline mit angeben function getPerson(/**String*/ name) { } Und ich kann sie wie folgt kombinieren, was in Ordnung funktioniert. /** @param [name] */ …

119 javascript google-closure-compiler jsdoc

1

Wie kann ein Array von Objekten als Parameter oder Rückgabewert in JSDoc angegeben werden?

In JSDoc zeigt die beste Dokumentation, die ich finden kann, Folgendes, wenn Sie ein Array eines bestimmten Typs (z. B. ein Array von Zeichenfolgen) haben: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Wie würden Sie die folgenden Fragezeichen ersetzen, um ein Array …

105 javascript documentation 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" …

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

3

Dokumentieren Sie den destruzierten Funktionsparameter in JSDoc

Bisher habe ich meine Objektparameter immer wie folgt dokumentiert: /** * Description of the function * * @param {Object} config - The configuration * @param {String} config.foo * @param {Boolean} [config.bar] - Optional value * @return {String} */ function doSomething (config = {}) { const { foo, bar } = …

89 arguments ecmascript-6 jsdoc destructuring

6

Wie kann die Art der Auflösung und Ablehnung des Versprechens in JSDoc angegeben werden?

Ich habe einen Code, der ein Versprechungsobjekt zurückgibt, z. B. die Q- Bibliothek für NodeJS. var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } Wie dokumentiere ich einen solchen Rückgabewert mit JSDoc?

83 javascript node.js documentation jsdoc promise

4

Richtiger Weg, um offene Argumentfunktionen in JSDoc zu dokumentieren

Angenommen, Sie haben etwa Folgendes: var someFunc = function() { // do something here with arguments } Wie würden Sie korrekt dokumentieren, dass diese Funktion eine beliebige Anzahl von Argumenten in JSDoc annehmen kann? Dies ist meine beste Vermutung, aber ich bin nicht sicher, ob es richtig ist. /** * …

82 javascript jsdoc

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 …

74 javascript dictionary 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 …

73 javascript node.js jsdoc autodoc jsdoc3

6

Beste Möglichkeit, anonyme Objekte und Funktionen mit jsdoc zu dokumentieren

Bearbeiten: Dies ist technisch eine zweiteilige Frage. Ich habe die beste Antwort ausgewählt, die die Frage im Allgemeinen abdeckt, und sie mit der Antwort verknüpft, die die spezifische Frage behandelt. Was ist der beste Weg, um anonyme Objekte und Funktionen mit jsdoc zu dokumentieren? /** * @class {Page} Page Class …

71 javascript documentation tags jsdoc

2

So generieren Sie JSDoc für die Funktion `pipe`d ES6

Ich habe eine ES6-ähnliche Funktion, die mithilfe der Funktionskomposition mit definiert wird asyncPipe. import { getItemAsync } from 'expo-secure-store'; const asyncPipe = (...fns) => x => fns.reduce(async (y, f) => f(await y), x); const getToken = () => getItemAsync('token'); const liftedGetToken = async ({ ...rest }) => ({ token: await …

10 javascript ecmascript-6 functional-programming intellisense jsdoc

Als «jsdoc» getaggte Fragen