Suchergebnisse für Anfrage "jsdoc"
So dokumentieren Sie einen Zeichenfolgentyp in jsdoc mit begrenzten möglichen Werten
Ich habe eine Funktion, die einen Zeichenfolge-Parameter akzeptiert. Dieser Parameter kann nur einen von wenigen definierten möglichen Werten haben. Was ist ...
Wie kann ich die Methoden eines verschachtelten Objekts mit JSDoc dokumentieren?
Ich habe versucht, mithilfe von JSDoc3 eine Dokumentation für eine Datei zu erstellen, habe jedoch einige Probleme. Die Datei (die ein Require.js-Modul ist) ...
JSDoc UML-Diagramm
Frage: Ich bearbeite und verwende eine Open-Source-Javascript-Bibliothek, deren Code JSDoc-Tags enthält. Ich habe mich gefragt, ob jemand ein JSDoc-Plugin ke...
JSDoc mit AngularJS
Derzeit verwenden wir in meinem Projekt JSDoc. Wir haben kürzlich mit der Implementierung von Angular begonnen, und ich möchte JSDoc weiterhin verwenden, um sicherzustellen, dass sich die gesamte Dokumentation an derselben Stelle befindet. Ich ...
Aufzählung als @param-Typ in JSDoc
Ist es möglich, eine Aufzählung für das JSDoc zu verwenden?@param Typdeklaration wie im folgenden Beispiel? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { }Wenn ich ...
Was ist der richtige Weg, um Rückrufe mit jsdoc zu dokumentieren?
Ich habe eine ganze Weile im Internet nach dem besten Weg gesucht, um 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. ...
JSDoc: Wie dokumentiere ich das Objektliteral "options" für eine übergeordnete "Klasse"? [Duplikat
Diese Frage hat hier bereits eine Antwort: Wie kann man "Objekt" -Argumente in jsdoc beschreiben? [/questions/6460604/how-to-describe-object-arguments-in-jsdoc] 5 Antworten Ich benutze jQuery's$.widget() base "class", die ein @ liefeoption() ...
Wie werden Javascript-Methoden in einer 'Gruppe' in JSDOC angezeigt?
Ist es möglich, Funktionen innerhalb einer Klasse zu gruppieren (AMD / RequireJS-Modul)? Meine Klassen haben manchmal mehr als 20 Funktionen, die tatsächlich zu einer bestimmten 'Schnittstellenimplementierung' gehören, und manchmal müssen sie nur ...
Wie kann man Express-Middlewares mit JSDoc kommentieren?
Ich versuche, eine Express-Middleware zu dokumentieren, aber das integrierte Validierungstool in WebStorm gibt an, dass im folgenden JSDoc-Block Typen falsch zugewiesen sind: /** * My middleware. * * @param {Object} req * @param {Object} res * ...