jsdoc

7Hitze

1Antwort

JSDoc Reihenfolge der Kommentare in der Ausgabe beibehalten

Ich habe ein JavaScript-Objekt, das einige öffentliche Methoden einführt, und ich möchte JSDoc verwenden, um sie zu dokumentieren. In der Quelldatei habe ich diese Funktionen gruppiert und geordnet in

javascript order jsdoc 2013-12-18

---

6Hitze

2Antwort

jsDoc - wie Array-Länge

In jsDoc angeben ich meine Array-Parameter und die Mitglieder wie folgt angeben: /** * @constructor * @param {Array.<string>} myArray */ function someFunction(myArray){ this.firstArray = myA

javascript arrays jsdoc maxlength specifications 2014-04-01

---

7Hitze

2Antwort

Enum als @param type in JSDoc

Ist es möglich, eine Enum für die JSDoc @param Deklaration wie im folgenden Beispiel zu verwenden? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES

javascript ide jsdoc jsdoc3 2014-02-11

---

5Hitze

1Antwort

Wie definiert man eine Funktion als Callback-Implementierung in JSDoc?

I definiert eine @callback auf diese Weise: /** * @callback MyClass~Handler * @param {string} target * @param {Options} options - Original options */ ich es verwenden, um meine Klasse Prototyp z

javascript jsdoc 2014-09-08

---

5Hitze

1Antwort

jQuery Plugin-Dokumentation mit JSDoc

Ich frage mich, wie man jQuery Plugin mit JSDoc zu dokumentieren? Mein Code ist: /** * The default configurations of comments * @typedef {Object} CommentConfig ... */ /**

javascript jquery jsdoc jsdoc3 2014-07-23

---

6Hitze

2Antwort

Dokumentations-Tool für TypeScript wie JSDoc

Gibt es ein Tool für Typescript, um automatisch Dokumentation aus kommentierten Kommentaren zu generieren? Ich versuchte mit JSDoc mit TypeScript. Es funktioniert bis zu einem gewissen Grad, aber sie

comments typescript documentation-generation jsdoc 2014-06-10

---

5Hitze

1Antwort

Gibt es einen offiziellen Auftrag für JSDoc-Tags in der Dokumentation?

Ich dokumentiere eine JavaScript API. Ich folge dem Google Style Guide, aber ich habe nichts über die Reihenfolge der Tags gefunden. dokumentiere ich in der Regel eine Variable wie folgt aus: /** * @

javascript tags order jsdoc google-style-guide 2014-06-19

---

27Hitze

2Antwort

JSDoc mit AngularJS

Momentan verwenden wir in meinem Projekt JSDoc, wir haben kürzlich mit der Implementierung von Angular begonnen und ich möchte weiterhin JSDoc verwenden, um sicherzustellen, dass sich die gesamte Doku

angularjs jsdoc jsdoc3 2014-01-22

---

9Hitze

1Antwort

Wie generiert man JSDoc-Kommentare für Funktionen, wenn kein Kommentar existiert?

Ich versuche ein Plugin für JSDoc zu erstellen. Ich folge der Dokumentation (was ironischerweise fehlt) und ich bin mir nicht sicher, wie ich das machen soll. Mein Plugin ist richtig geladen, und ich

plugins comments jsdoc 2014-01-23

---

7Hitze

1Antwort

Die Fehlermeldung „Es gibt keine Eingabedateien zu verarbeiten“ von jsdoc

Jsdoc installiert ist lokal (NPM installieren jsdoc). Ich erhalte die folgende Fehlermeldung beim Versuch, .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js Ausgabe auszuführen: DEBUG: JSDoc

javascript node.js jsdoc jsdoc3 2014-06-25

---