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 
*/