Tag: jsdoc
JSDoc ist eine syntax für das hinzufügen von inline-API-Dokumentation zu JavaScript-source-code. Dies unterscheidet sich von den verschiedenen Werkzeugen zum Parsen und manipulieren von code, der folgt der JSDoc-syntax.
Legen Sie den relativen link in reStructuredText
1 Antworten
Dokumentiere ich eine Bibliothek, eine Python-Komponente und eine JavaScript-Komponente. Die Allgemeine Benutzer-Dokumentation, und die Python-API-Dokumentation sind in reStructuredText, verarbeitet mit Sphinx. Die JavaScript-API ist in der jsdoc-und verarbeitet werden, mit jsdoc-toolkit. Der AUFTRAGGEBER Ausgabeformat HTML. Ich bin
Dokumentation einer javascript-Klasse, die mit Prototypen in einem namespace mithilfe von jsdoc-toolkit
2 Antworten
Ich versuche sehr hart, um Dokument-code in das format unter mithilfe von jsdoc-toolkit. Es sieht für mich wie die tags, die ich verwendet habe, erzeugen sollte, das gewünschte Ergebnis, aber es funktioniert nicht. Stattdessen warnt, dass die
Wie Dokument aufgelöst Werte von JavaScript verspricht
2 Antworten
Angesichts dieser code : function asyncFoo() { return new Promise(function (fulfill, reject) { doAsyncStuff(function(err, data) { if(err) reject(new Error(err)); else fulfill(new Bar(data)); }); }); } Wie kann ich ein Dokument, dass asyncFoo zurück Promise, die, wenn erfüllt,
Was ist der richtige Weg, um Dokument ein jQuery-parameter geben Sie mit JSDoc?
2 Antworten
Ich versuche zu dokumentieren, die mein Programm mit der JSDoc-syntax für mich und die Menschen, die sich auf meinen code. Ich versuche auch, meine Sachkenntnisse zu verbessern. Für einen parameter der jQuery-Typ, ich bin ein wenig verwirrt.
Wie kann ich die outline in eclipse bei Verwendung des revealing module pattern?
4 Antworten
Ich bin derzeit refactoring einige Javascript-code, den wir haben und unter anderem Dinge, die ich geändert habe, es zu benutzen und aufschlussreich-Modul-Muster. Der code ist auf der Suche viel aufgeräumter und es funktioniert gut, aber ich kann
Wie JsDoc-ein "mixed" - Typ?
2 Antworten
Einfache Frage, wie dokumentiere ich, dass "Mixed-type"? Ich weiß, ich könnte einfach eine Liste aller möglichen Typen wie {null|undefined|String|Number|Object} und Ende finden, mir fehlt einer und macht es zu Komplex. Ich habe versucht mit der Mixed-Schlüsselwort, aber
Gibt es eine Möglichkeit zu definieren generische Typen in JS Dokumentation?
1 Antworten
Ich bin auf der Suche nach Dokumentation generator für mein JS-Bibliothek. Ich finde JSDuck die umfassendste und kraftvoll. Aber ich sehe nicht, einen Weg zu definieren, geben Sie die Variablen für generische Klassen und Funktionen, die mit
Dokument-Auflistung (array type) Rückgabewert und die parameter in der JSDoc -
5 Antworten
Wie Dokument Array Rückgabewert (und Parameter) in der JSDoc-wenn array-Elemente kann eine der folgenden: Eines Typs (z.B. String, Array). Ein Objekt-literal. InformationsquelleAutor Jonathan Chan | 2011-12-14
Angular2 Dokumentations-Generator
2 Antworten
Gibt es einen Dokumentations-generator (kann eine Knoten-Paket) wie in anderen Programmiersprachen (jsdoc /phpdoc /javadoc /..) für typescript-basierten Angular2-Projekte? dgeni github.com/rangle/angular2-dgeni-starter Ja, danke/danke, dass ich jetzt auch diese Samen (github.com/mgechev/angular2-seed) hat npm run build.docs. Aber ich bräuchte eine
Wie bekomme ich JSDoc zu markieren, meine param als ein jQuery-Objekt?
1 Antworten
Versuche ich zu gründlich Kommentar meine JavaScript-und ich bin mit JSDoc. Ich habe eine Funktion, die verbraucht ein jQuery-Objekt, und ich möchte markieren Sie den parameter als solchen. Derzeit habe ich dieses: /** * Initializes a login
Enum als @param type-in JSDoc
2 Antworten
Ist es möglich, ein enum für die JSDoc @param Typ-Deklaration, wie in dem folgenden Beispiel? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES }
jsdoc gültige param Typen
2 Antworten
Gibt es irgendwo eine übersicht von gültigen Typen für die param-tags für jsdoc? Zum Beispiel, @param {type} myParam Some parameter description Ich weiß, dass Dinge wie number und String gültig sind, aber was ist, wenn ich will,
Wie zu tun-Dokumentation in ReactJS?
5 Antworten
Habe ich eine Anforderung zu erstellen, die die doc-Datei von jeder einzelnen Komponente wir definieren in unserem reactjs Anwendung.Ich bin auf der Suche nach dem npm, dass wir kann für die Erstellung des Dokuments von jeder Erweiterung,
Wie verwende ich JSDoc auf Windows?
3 Antworten
Verzeihen Sie mir, wenn dies ist eine alberne Frage, aber ich bin völlig verwirrt, wie kann ich verwenden JSDoc auf Windows. Ich bin mir bewusst, dass der JSDoc-Toolkit, aber es ist ein bisschen veraltet, und der google-code-repository
Richtige Weg, um Dokument öffnen-ended-argument-Funktionen in JSDoc
4 Antworten
Lassen Sie uns sagen, Sie haben so etwas wie die folgenden: var someFunc = function() { //do something here with arguments } Wie würden Sie richtig dokumentieren, dass diese Funktion eine beliebige Anzahl von Argumenten in der
WebStorm: Wie generieren JSDoc-Dokumentation
3 Antworten
Ich gerade angefangen mit WebStorm und JSDoc-Dokument-JavaScript. Ich habe noch keinen Weg gefunden, generieren eine HTML-Dokumentation mit einer Art von WebStorm built-in-Funktionalität. Ich suchte im web und Stack-Überlauf, fand aber nur eine Menge von Fragen über die
linux-shell-append variable Parameter zum Befehl
4 Antworten
Ich versuche ein bash-Skript, das erzeugt JSDoc für gegebene Parameter wie in diesem ./jsdoc.sh file.js another.js maybe-a-third.js Ich bin stecken, wie übergeben Sie eine unbekannte Menge von Parametern, um die nächste shell-Befehl. (auch die, die nicht wissen,
Angularjs, Wie zum generieren von HTML-code Dokumentation
3 Antworten
Tut jedermann haben keine Erfahrung dokumentieren/strukturieren angularjs-Projekte, so dass die JSDoc erzeugen kann, die netten Kommentare (für Ihre Direktiven, Controller, Filter etc.) in ein HTML-format? Im moment erzeugt es eine Datei mit dem _global-Klasse, die Punkte auf
Wie kann ich in JsDoc void zurückgeben?
4 Antworten
Gibt es einen festgelegten Art und Weise zu erklären, eine Methode oder eine Funktion void zurück in JsDoc? Zurzeit bin ich in der überzeugung, dass void ist der Standardwert zurückgegeben, und andere Werte zurückgegeben werden, müssen speziell:
Wie erstellt man einfach Github-freundliche Abschriften für dokumentierte JavaScript-Funktionen?
7 Antworten
Ich möchte in der Lage sein zu nehmen JSDoc-Kommentare wie diese überall im JavaScript-source (sogar verschachtelt mehrere Schichten von Funktionen in einem Modul oder auch anonyme Funktionen): /** * Used to do some important thing that needs
Wie kann ich die Auflösung und den Ablehnungs-Typ des Versprechens in JSDoc angeben?
6 Antworten
Ich habe einige code, der gibt ein promise-Objekt, z.B. mit 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 zu
Wie dokumentiert man ein Require.js (AMD) Modul mit jsdoc 3 oder jsdoc?
5 Antworten
Ich habe 2 Arten von Modulen: Require.js Main-Datei: require.config({ baseUrl: "/another/path", paths: { "some": "some/v1.0" }, waitSeconds: 15, locale: "fr-fr" }); require( ["some/module", "my/module", "a.js", "b.js"], function(someModule, myModule) { } ); Mediator-Muster: define(, function(Mediator){ var channels =
Wie kann ich die Methoden eines geschachtelten Objekts JSDoc A?
4 Antworten
Ich habe versucht, zu verwenden JSDoc3 Dokumentation generiert werden, auf eine Datei, aber ich habe einige Schwierigkeiten. Die Datei (eine Require.js Modul) im wesentlichen wie folgt aussieht: define(, function() { /* * @exports mystuff/foo */ var foo
So dokumentieren Sie die Eigenschaften des Objekts im JSDoc 3-Tag: @this
3 Antworten
Den @param - tag ermöglichen die Dokumentation von Eigenschaften, z.B. /** * @param {Object} userInfo Information about the user. * @param {String} userInfo.name The name of the user. * @param {String} userInfo.email The email of the user.
JSDoc mit AngularJS
2 Antworten
Derzeit in meinem Projekt sind wir mit JSDoc, wir haben vor kurzem damit begonnen, zu implementieren, Winkel-und ich möchte auch weiterhin mit JSDoc, um sicherzustellen, dass alle Dokumentation ist innerhalb der gleichen Stelle. Habe ich einen Blick
JSDoc: Rückgabeobjektstruktur
2 Antworten
Wie kann ich sagen JSDoc über die Struktur eines Objekts, das zurückgegeben wird. Ich habe festgestellt, dass @return {{field1: type, field2: type, ...}} description syntax und versuchte es: /** * Returns a coordinate from a given mouse
Wie dokumentiere ich ein Wörterbuch in JSDoc?
2 Antworten
Dass nächste Beispiel: var CONF = { locale: { "en": { name: "English", lang: "en-US" }, "es": { name: "Spanish", lang: "es-ES" } } }; Kennen und wissen, dass das, was die locale-Eigenschaft enthält, wird ein dictionary-Objekt
Richtiger Weg, um offene Argumentfunktionen in JSDoc zu dokumentieren
4 Antworten
Lassen Sie uns sagen, Sie haben so etwas wie die folgenden: var someFunc = function() { //do something here with arguments } Wie würden Sie richtig dokumentieren, dass diese Funktion eine beliebige Anzahl von Argumenten in der
Wie spezifiziert man ein Array von Objekten als Parameter oder Rückgabewert in JSDoc?
1 Antworten
In JSDoc, die beste Dokumentation, die ich finden kann zeigt, verwenden Sie die folgende, wenn Sie ein array eines bestimmten Typs (wie ein array von strings): /** * @param {Array.<string>} myStrings All my awesome strings */ function
Beste Möglichkeit, anonyme Objekte und Funktionen mit jsdoc zu dokumentieren
6 Antworten
Edit: Das ist technisch eine 2-teilige Frage. Ich habe gewählt die beste Antwort, die sich um die Frage, im Allgemeinen und im Zusammenhang mit der Antwort, dass Griffe die konkrete Frage. Was ist der beste Weg, um
Wie beschreibt man "Objekt" Argumente in jsdoc?
5 Antworten
//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 kann ich beschreiben, wie die Parameter-Objekts sollten strukturiert sein? Zum Beispiel
JSDoc fügt echten Code in die Dokumentation ein
6 Antworten
Wissen Sie, ob es ist irgendeine Art von <code /> tag in JSDoc? Ich muss hinzufügen von code-Stücken, die in meiner Dokumentation wie diese: /** * This function does something see example below: * * var x
Wie dokumentiert man den CoffeScript-Quellcode mit JSDoc?
5 Antworten
Ich habe einige code in CoffeeScript geschrieben und ich wollen zu optimieren den erzeugten JavaScript mit dem Google Closure Compiler, so dass diese Dateien müssen dokumentiert werden mit JSDoc. Meine Frage ist, wie kann ich das Dokument
Wie dokumentiere ich einen String-Typ in jsdoc mit begrenzten möglichen Werten?
4 Antworten
Ich bin eine Funktion akzeptiert einen string-parameter. Dieser parameter kann nur ein paar definierte Werte möglich. Was ist der beste Weg, um Dokument gleich? Sollte shapeType definiert werden als enum-oder TypeDef-oder etwas anderes? Shape.prototype.create = function (shapeType)
Gibt es eine Möglichkeit, JSDoc-Kommentare in Visual Studio Code zu generieren
4 Antworten
Ich bin derzeit an der Entwicklung einer NodeJS-Projekt und fand heraus, dass es keine eingebaute Funktionalität zum erstellen von JSDoc-Kommentare für Funktionen/Methoden. Ich bin mir bewusst, die TypeScript Definitionen, die existieren, aber ich konnte nicht wirklich etwas
Wie dokumentiere ich Callbacks mit jsdoc?
3 Antworten
Habe ich damit verbracht eine ganze Weile durchforstet das internet auf der Suche nach dem besten Weg, um richtig zu dokumentieren Rückrufe mit jsdoc, aber leider, ich habe nicht gefunden, ein großer, noch. Hier ist meine Frage:
Wie kann man angeben, dass param optional ist, wenn man JSDoc inline verwendet?
3 Antworten
Entsprechend der JSDoc-wiki für @param geben Sie an @param ist optional mit /** @param {String} [name] */ function getPerson(name) { } und Sie kann auf eine param inline mit function getPerson(/**String*/ name) { } Und ich kann