JSDocでのみ変数のドキュメントを生成するにはどうすればいいですか？

Question

私は、コメントされているグローバル変数の多くを含むjavascriptファイルを持っていますが、JSDocは "何も書かれていません"と伝えています。ここで

はサンプルです：

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

は、.jsファイルのためのドキュメントを生成する方法はありますか？

Answer 1

JSDoc.pmという古いPerlベースのプロジェクトを使用しているようです。 JsDoc Toolkitという新しいプロジェクトにアップグレードすることをお勧めします。新しいプロジェクトの構文は、ほとんどの場合、古いプロジェクトで使用されていたタグのスーパーセットですが、サポートされるすべてのタグの完全なリストについてはwiki on the JsDoc Toolkit projectをご覧ください。

以下はJSDocのツールキットで動作します：

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