Wie kann ich den Umriss in Eclipse anzeigen, wenn ich das aufschlussreiche Modulmuster verwende?

Ich überarbeite gerade einen JavaScript-Code, den wir haben, und habe ihn unter anderem geändert, um das aufschlussreiche Modulmuster zu nutzen. Der Code sie...

Wie kann man ein Array von Objekten als Parameter oder Rückgabewert in JSDoc angeben?

In JSDoc wird in der besten Dokumentation, die ich finden kann, Folgendes angezeigt, wenn Sie über ein Array eines bestimmten Typs (z. B. ein Array von Zeich...

Wie dokumentiert man ein Array von Objekten als Parameter in JSDoc?

Ich habe ein Array, das so aussieht:

So dokumentieren Sie die Retoure in JavaScript

Ich schreibe meine eigene Bibliothek für das Projekt bei der Arbeit für eine Browseranwendung und habe das gleiche alte Problem bei der Entscheidung, wie der...

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 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 * ...

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 ...

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 ...

Wie dokumentiere ich ein Require.js (AMD) Modul mit jsdoc 3 oder 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 ...