我使用以下命令从javascript文件生成html。
$> jsdoc --debug jquery.js
$> open out/index.html
输出命令
DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT)
DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true,"dictionaries":["jsdoc","closure"]},"templates":{"monospaceLinks":false,"cleverLinks":true},"source":{"includePattern":".+\\.js(doc)?$","excludePattern":"(^|\\/|\\\\)_"},"plugins":[]},"opts":{"_":["jquery.js"],"configure":"conf.json","debug":true,"destination":"./out/","encoding":"utf8"}}}
DEBUG: Parsing source files: ["/Users/darpandagha/jquery.js"]
Parsing /Users/darpandagha/jquery.js ...complete.
DEBUG: Finished parsing source files.
DEBUG: Indexing doclets...
DEBUG: Adding inherited symbols, mixins, and interface implementations...
DEBUG: Adding borrowed doclets...
DEBUG: Post-processing complete.
Generating output files...complete.
Finished running in 2.76 seconds.
答案 0 :(得分:6)
在最后一个jsdoc版本中,您可以在命令行上使用“-R README.md”指定索引内容,并将所需内容放入此文件中。 我在DocStrap documentation找到了这个。