JSDoc 생성 문서의 그룹화 함수

Question

나는 작업중인 lib에 대한 문서 생성을 처리하기 위해 documentationjs (jsdoc를 사용)을 사용하고 있습니다. 내 라이브러리는 ES6이며 완전한 기능을 제공하며 현재 생성 된 문서는 lib의 모든 모듈에있는 모든 함수의 알파벳 순 목록입니다. 이것은 당신이 찾고있는 것을 찾는 것을 매우 어렵게 만듭니다. 한 파일의 함수가 문서에서 함께 그룹화되도록 jsdoc 주석을 어떻게 사용해야합니까? 다음 파일을 주어진 예를 들어

, ...

/** 
* Docs for alpha 
*/ 
export const alpha =() {}; 

/** 
* Docs for beta 
*/ 
export const beta =() {}; 

/** 
* Docs for charlie 
*/ 
export const charlie =() {}; 

... 어떻게 jsdoc 코멘트 세 가지 기능을 함께 문서에 '예'아래에 그룹화됩니다 보장을 사용해야합니까?

클래스 상단에 모듈을 정의 해 보았습니다. /** @module Example */하지만이 클래스는 문서에서 '예제'라는 항목을 생성하지만 함수는 그 아래에 그룹화되지 않습니다.

개별 기능의 문서에 @memberof Example을 추가하려고 시도했지만 아무런 효과가 없습니다.

나는 this을 알고 있지만, 아마도 ES6 임포트 때문에 나를 위해 작동하지 않습니다. 의 사용에 대한 언급은 the docs에 없습니다.

Answer 1

documentationjs는 생성 된 문서에서 JSDoc 스타일 그룹화를 지원하지 않지만 약간 다른 구문을 사용하여 기능을 그룹화 할 수 있습니다. 나는 때문에 documentationjs 년대 (아이러니하게도) 가난한 설명서를 시행 착오를 통해 발견 :

/** @module Example **/ 

/** 
* @memberof Example 
*/ 
const alpha =() => {}; 

참고하십시오 @member 인수에 대한 module: 접두사가 없다.

Answer 2

아마도 jsdoc이 그룹화를 구현할 때까지이 해결 방법을 시도해 볼 수 있습니다.

How to display Javascript methods in a 'group' in JSDOC?

Answer 3

나는이 방법으로 @module를 사용할 필요가 있다고 생각 :

/** @module myModule */ 

/** will be module:myModule~foo */ 
var foo = 1; 

/** will be module:myModule.bar */ 
var bar = function() {}; 

으로는 here을 설명했다.