首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Jsdoc不排除路径

Jsdoc不排除路径
EN

Stack Overflow用户
提问于 2019-05-13 17:44:29
回答 1查看 420关注 0票数 0

我使用的是Jsdoc 3.6.2。我在conf.json中有这个源配置:

代码语言:javascript
复制
"source": {
        "exclude":["MyProj/excludeFolder"],
        "includePattern": ".+\\.js(doc|x|xinc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    }

当我在MyProj目录上执行jsdoc -r -c pathToMy/conf.json时,Jsdoc没有排除'excludeFolder‘文件夹。我知道它使用的是正确的config.json文件,因为它包含了所有的.jsxinc文件。我怎么才能修复它呢?

编辑:我正在使用Windows10和vscode。Jsdoc全局安装在C:/Users/myUser/appData/Roaming/npm上。我在C:/Users/myUser/myProject上创建了一个玩具项目,结构如下:

代码语言:javascript
复制
myProject/
|-out/
    |-conf.json
|-src/
    |-includeFile.jsxinc
    |-excludeFolder/
        |-exludeFile.jsxinc

这是完整的conf.json:

代码语言:javascript
复制
{
    "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’中的代码:

代码语言:javascript
复制
/**
* @class
*/
function excludeClass(){}

这是‘in deFile.jsxinc’中的代码:

代码语言:javascript
复制
/**
* @class
*/
function includeClass(){}

当我在power shell上的C:/Users/myUser/myProject:jsdoc -c C:/Users/myUser/myProject/out/conf.json -r.上运行以下命令时,会为这两个类生成文档: includeClass和excludeClass。在实际项目中,exclude文件夹包含使用jsdoc的第三方库。

EN

回答 1

Stack Overflow用户

发布于 2020-05-30 08:29:36

我也面临着同样的问题,我解决了这个问题:

代码语言:javascript
复制
"excludePattern": "myProject/src/excludeFolder"

并删除“排除”属性。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/56109736

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档