JSDoc 两次输出相同的变量

问题描述 投票:0回答:3

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

这是结果:

javascript jsdoc jsdoc3
3个回答
3
投票

我发现了错误。发生这种情况是因为在我使用的配置中:

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

并且

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

如果我将 include 更改为空数组,它将输出所有内容一次。我以为 includePattern 只会过滤包含的所有内容,但事实并非如此。它再次匹配文件。


1
投票

我也有类似的问题。我在配置文件中的命令行中传递源代码。

{
  "source": {
    "include": [
      "src"
    ]
  }
}

jsdoc -c jsdoc.json ./src

我必须从配置或命令中删除它。我选择从命令中删除它
jsdoc -c jsdoc.json


0
投票

我在两个不同的场合遇到过这个问题。(jsdoc 3.6.10 和 docdash 1.2.0)

有一次是因为文件中有一个空注释造成的,就像这样。

/*
* 
* */

删除空注释消除了重复输出。

另一次重复输出是由我在 jsdoc.json 中的“includes”数组引起的

这导致了:

"include": ["./src", "./src/lib"]

这没有:

"include": ["./src"]
© www.soinside.com 2019 - 2024. All rights reserved.