11

Jsdoc is installed locally ( npm install jsdoc ). I get the following error while trying to execute .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js Output: DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true},"templ ates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles" :true}},"source":{"includePattern":".+\.js(doc)?$","excludePattern":"(^|\/|\\ )_"},"plugins":[]},"opts":{"_":["./lib/JavaScriptSource.js"],"debug":true,"destina tion":"./out/","encoding":"utf8"}}} There are no input files to process.

JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT)

Options:
-t, --template <value>       The path to the template to use. Default:
                             path/to/jsdoc/templates/default
-c, --configure <value>      The path to the configuration file.
                             Default: path/to/jsdoc/conf.json 
.....
</code>
4

1 回答 1

14

Turns 是 jsdoc 中的一个开放错误，它不处理以“_”开头的文件路径。github.com/jsdoc3/jsdoc/issues/308。也提供解决方案。

默认的 excludePattern (^|/|\)_ 忽略以下划线开头的路径。

引用自https://github.com/jsdoc3/jsdoc/issues/308的解决方案

“要更改默认行为：

将 conf.json.EXAMPLE 复制到一个新文件 conf.json。您可以将它放在 JSDoc 目录或其他目录中。如果将它放在另一个目录中，则需要使用 -c 选项告诉 JSDoc 在哪里可以找到它： jsdoc -c path/to/conf.json 在文本编辑器中打开 conf.json。找到 source.excludePattern 属性，并将其更改为空字符串。”

于 2014-06-26T02:36:45.673 回答