Jsdoc在本地安装(npm install jsdoc)。尝试执行时出现以下错误
.\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js
输出:
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>
答案 0 :(得分:13)
转换是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属性,并将其更改为空 字符串“