현재 jsdoc을 사용하여 JS 파일을 문서화하고 있지만 일부 문제가 있습니다. 두 파일, file1.js 및 file2.js (실제 이름은 분명히 아닙니다)이 있습니다. 이 두 파일에는 jsdoc 스타일로 문서화 한 많은 함수가 들어 있습니다. 두 파일 모두에서 jsdoc을 실행할 때 출력은 설명과 함께 전역 함수 목록입니다. 함수가 실제로 어디에 있는지는 구별이 없습니다 (file1.js 또는 file2.js). 내 문서를 더 나은 구조로 만들기 위해이 구별을 만들 수있는 방법이 있습니까?jsdoc 출력의 전역 변수 방지
는 각 파일에 @module 태그를 사용할 수 있습니다 :
/**
* @module file1
*/
당신은 다른 파일에 대한 file2을 사용하십시오. 귀하의 모듈이 귀하의 파일과 동일한 이름을 갖을 것으로 가정했습니다.
모듈에있는 항목을 참조하려면 module: 표기법을 사용합니다. 따라서 file1 모듈에 foo이라는 클래스가있는 경우 @returns {module:file1~foo}을 사용하면 다른 모듈의 함수가 반환하는 데이터 유형을 기록 할 수 있습니다. 물결 표식은 here으로 설명됩니다. foo은 모듈 file1의 "내부"멤버임을 나타냅니다. ("정적"멤버로 만드는 것이 내 의견으로는 좋지만 jsdoc의 현재 버전은 모듈 용으로 잘 처리하지 못합니다.)