JSdocを使って別のファイルの@classを参照する方法は？

Question

など。 MyClass.js

/** 
* @class 
* @name module:Bar 
* @param {number} a1 
* @param {string} a2 
*/ 
function Bar(a1, a2){} 

そして、別のファイルに：

/** @type module:Bar.constructor */ // made up syntax 
var Bar = require("./MyClass.js"); 

再定義@class作品が、それは便利ではありません。

/** 
* @class 
* @name module:Bar 
* @param {number} a1 
* @param {string} a2 
*/ 
var Bar = require("./MyClass.js"); 

は、私はそれをどのように行うのですか？

Answer 1

クラス名だけで十分です。

警告：

/** 
* @type module:Bar 
*/ 
var Bar = require("./MyClass.js"); 

あなたは@nameの代わりに@aliasを使用する必要があります@nameタグを使用することにより、あなたは 周辺のコードを無視して、単独であなたのドキュメンテーションコメントを治療するためのJSDocのを言っています。 多くの場合、代わりに@aliasタグを使用することをお勧めします。このタグは、ドキュメント内の シンボルの名前を変更しますが、シンボルについては他の情報を保持します（ ）。バーのインスタンスを参照する

/** 
* @class 
* @alias module:Bar 
* @param {number} a1 
* @param {string} a2 
*/ 
function Bar(a1, a2){}