JSDocでクラスのインスタンスをエクスポートするモジュールを文書化するには

Question

私はJavascriptプロジェクトで作業しています。デフォルトの書き出し（モジュールが必要なときに得られるもの）は、クラスを拡張するクラスのインスタンスです。例えば

：

/** 
* @module my-module-name 
*/ 

/** 
* Private so documentation doesn't mention DefaultRouter 
* @private 
*/ 
class DefaultRouter extends Router { 
    /** 
    * Extra method docs 
    */ 
    extreMethod() {} 
} 
export default new DefaultRouter(); 

（理想的には）これのドキュメント（つまり、開発者が利用できるよう）ルータのクラスが含まれており、拡張クラスRouterなどのためのドキュメントを含めてモジュールのAPIの表面を示すだろうよくextraMethodとなります。

@alias module:my-module-name.extraMethodを使用してextraMethodドキュメントが表示されることがありますが、Routerメソッドを公開するためのきれいな方法が見つかりません。

もっと簡単な方法でこれを行うにはどうすればよいですか？いくつか@タグ付き？

Answer 1

少し遊んだあと、私はそれが欲しかったように動作するように思われる@borrowsタグを見つけました。

/** 
* @module my-module-name 
* @borrows module:my-module-name.Router#methodName as methodName 
*/