Wie Dokumentation für Vars nur mit JSDoc erstellen?

Question

Ich habe Javascript-Datei, die eine Menge von globalen Vars enthält, die kommentiert werden, aber JSDoc sagt ständig, dass es "Nichts zu dokumentieren, zu beenden". Hier

ist ein Beispiel:

/** 
* Name of the clients list 
* @type String 
* @final 
*/ 
var CLIENTS_LIST_NAME = "Client"; 

Gibt es eine Möglichkeit Dokumentation für eine solche js-Datei zu erzeugen?

Answer 1

Es sieht so aus, als ob Sie mein altes Perl-basiertes Projekt namens JSDoc.pm verwenden. Ich würde Ihnen empfehlen, auf mein neueres Projekt namens JsDoc Toolkit zu aktualisieren. Die Syntax des neueren Projekts ist meist eine Obermenge der Tags, die im älteren Projekt verwendet wurden. Eine vollständige Liste aller unterstützten Tags finden Sie unter wiki on the JsDoc Toolkit project.

Im Folgenden wird in JsDoc Toolkit arbeiten:

/** 
 * Name of the clients list 
 * @type String 
 * @constant 
 */ 
var CLIENTS_LIST_NAME = "Client";