我正在使用Jsdoc 3.6.2。我在conf.json中有此源配置:
"source": {
"exclude":["MyProj/excludeFolder"],
"includePattern": ".+\\.js(doc|x|xinc)?$",
"excludePattern": "(^|\\/|\\\\)_"
}
当我在MyProj目录上执行jsdoc -r -c pathToMy/conf.json
时,Jsdoc并不排除'excludeFolder'文件夹。我知道它使用的是正确的config.json文件,因为它包括所有.jsxinc文件。我该如何解决?
编辑: 我正在使用Windows 10和vscode。 Jsdoc全局安装在C:/ Users / myUser / appData / Roaming / npm上。我已经在C:/ Users / myUser / myProject上创建了一个玩具项目,其结构如下:
myProject/
|-out/
|-conf.json
|-src/
|-includeFile.jsxinc
|-excludeFolder/
|-exludeFile.jsxinc
这是完整的conf.json:
{
"tags": {
"allowUnknownTags": true
},
"source": {
"exclude":["myProject/src/excludeFolder"],
"includePattern": ".+\\.js(doc|x|xinc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [],
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"outputSourceFiles": true
}
}
}
这是“ excludeFile.jsxinc”中的代码:
/**
* @class
*/
function excludeClass(){}
这是'includeFile.jsxinc'中的代码:
/**
* @class
*/
function includeClass(){}
当我在C:/ Users / myUser / myProject:jsdoc -c C:/Users/myUser/myProject/out/conf.json -r.
的Power Shell上运行以下命令时,将为两个类(包括includeClass和excludeClass)生成文档。在实际项目中,exclude文件夹包含使用jsdoc的第三方库。
答案 0 :(得分:0)
我遇到了同样的问题,并且对此进行了解决:
"excludePattern": "myProject/src/excludeFolder"
并删除“排除”属性。