Slide 22
Slide 22 text
JSDoc: 설정
• jsdoc.json
JSON 타입의 설정 파일
• 수정할 부분
source/include에 참조할 파일 명기
ü 또는 includePattern에 패턴 기록
제외할 디렉토리 추가
ü node_modules가 들어가지 않도록 주의해야 함
ü 엄청 커집니다.
{
"tags": {
"allowUnknownTags": false
},
"source": {
"include": ["./backend.ai-client-node.js"]
,
"includePattern": ".js$",
"exclude": ["./docs"],
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"opts": {
"encoding": "utf8",
"destination": "./docs",
"recurse": true,
"verbose": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"outputSourceFiles": false
}
},
"docdash": {
"static": false,
"sort": false
}
}