Suchergebnisse für Anfrage "jsdoc"
Wie man Zeilenumbrüche in Google Apps jsdoc-Beschreibungen erzwingt
Ich kann nicht herausfinden, wie dies in einem Google Apps-Skript korrekt angezeigt wird. Ich brauche es, um neue Zeilen in der jsdoc-Ausgabe anzuzeigen (z. B. wenn das Funktions-Tooltip-Fenster in einer Tabellenkalkulation angezeigt wird.) Ich ...
jsdoc: mehrzeilige Beschreibung @ property
Ich dokumentiere meinen Code mit jsdoc, soweit so gut, ich habe einen Kommentar wie unten ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property...und es kommt in HTML-Dokument ...
JSDoc: Objektstruktur zurückgeben
Wie kann ich JSDoc über die Struktur eines zurückgegebenen Objekts informieren? Ich habe das @ gefund@return {{field1: type, field2: type, ...}} description syntax und probiert es aus: /** * Returns a coordinate from a given mouse or touch event ...
Wie dokumentiere ich eine Funktion, die von einer Funktion mit JSDoc @ zurückgegeben wurd
Ich verwende JSDoc für die Parameterdokumentation. Es ist klar, wie die Parametertypen für @ dokumentiert werdemany_prompts, aber wie kann die zurückgegebene Funktion richtig dokumentiert werden? /** * @param {Number} - number of times to ...
Default "Home" -Text und Inhalt für JSDoc
Nach dem Ausführen eines grundlegenden JSDoc-Kompilier- / Rendervorgangs von Node.js: jsdoc file1.js file2.jsIch erhalte ein gut formatiertes Dokument mit der Standardvorlage in einem Verzeichnis "out". Fast alles ist wie erwartet! Aber beim ...
Wie erweitere ich einen typedef-Parameter in JSDOC?
Angenommen, Sie haben den folgenden Code in einer ES6-Klasse (Dokumentation): /** * @typedef Test~options * @type {object.<string>} * @property {array} elements - An array containing elements * @property {number} length - The array length */ /** ...
Document destructured function parameter in JSDoc
Vorher 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} ...