JSDoc两次输出相同的变量

时间:2017-01-03 16:34:16

标签: javascript jsdoc jsdoc3

JSDoc两次打印所有成员的列表。在这些列表中,它还会打印每个成员两次。知道什么可能导致这种行为吗?

这是我的代码:

/** @module styles */

/**
 * Contains the general styles
 * @var _
 */

var _ = StyleSheet.create({});

这是我的配置文件:

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc", "closure"]
  },
  "source": {
    "include": [ "./styles.js" ],
    "includePattern": ".+\\.js$",
    "excludePattern": ""
  },
  "plugins": [],
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  },
  "opts": {
    "destination": "./docs/",
    "encoding": "utf8"
  }
}

这是生成文档的命令:

jsdoc . -c conf.json

结果如下:

enter image description here

1 个答案:

答案 0 :(得分:1)

我发现了错误。它发生的原因是我正在使用的配置:

"include": [ "./styles.js" ], 

"includePattern": ".+\\.js$",

如果我将include更改为空数组,则输出一次。我认为includePattern只会过滤掉所有内容,但情况并非如此。它再次与文件匹配。