2009-06-24 10 views
0

J'ai un fichier javascript qui contient beaucoup de vars globaux qui sont commentés, mais JSDoc n'arrête pas de dire qu'il y a "Nothing to document, exiting".Comment produire de la documentation pour vars uniquement avec JSDoc?

Voici un exemple:

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

est-il un moyen de générer de la documentation pour un tel fichier .js?

Répondre

2

Il semble que vous utilisiez mon ancien projet basé sur Perl nommé JSDoc.pm. Je vous recommande de mettre à niveau vers mon nouveau projet nommé JsDoc Toolkit. La syntaxe du projet le plus récent est la plupart du temps un surensemble des balises utilisées dans le projet plus ancien, mais jetez un oeil à la wiki on the JsDoc Toolkit project pour une liste complète de toutes les balises supportées.

Ce qui suit travailler dans jsdoc Toolkit:

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