叉线信息
这回贷被扣了,因为我们需要加注 这个 修复.
我们将出版 释放 npm 地产登记册上的分支
此 lib 被使用 这里
联署材料文件3
JavaScript 的 API 文档生成器 .
想给JSDoc捐款吗? 请阅读 CONTRIBUTING.md。 。 。 .
安装和使用
JSDoc支持"节点"(Node.js 0.10)及后期. 您可以在您的项目中安装 JSDoc
node_modules 文件夹,也可以在全球安装.
安装国家预防机制最新版本:
npm install jsdoc
要安装最新的开发版本 :
npm install git+https://github.com/jsdoc3/jsdoc.git
如果您在本地安装了 JSDoc, JSDoc 命令行工具可在
./node_modules/.bin生成文件文档
yourJavaScriptFile.js数字 :
./node_modules/.bin/jsdoc yourJavaScriptFile.js
或者如果你在全球安装了JSDoc, 只需运行 jsdoc 命令 :
jsdoc yourJavaScriptFile.js
默认情况下,生成的文档会被保存在一个命名的目录中 out。 。
可以使用 --destination (单位:千美元)-d)指定另一个目录的选项.
运行 jsdoc --help 用于完整命令行选项列表.
模板和构建工具
JSDoc社区创建了许多模板和其他工具来帮助你 生成和自定义文档。 这里只有几个:
模板
- 贾古阿吉斯多克 (单位:千美元)实例(中文(简体) )
- 标签 (单位:千美元)实例(中文(简体) )
- jsdoc3 模板 (单位:千美元)实例(中文(简体) )
- min
- 多克达什(单位:千美元)实例(中文(简体) )
构建工具
更多信息
- 文件备查 使用 JSDoc。 。 。 .
- 协助文件 jsdoc3/jsdoc3.github.com (中文(简体) )。 。 。 .
- 请求帮助 联合来文文件 用户邮件列表。 。 。 .
- 贴有标签的帖子问题
jsdoc改为 堆栈 过多。 。 。 .
许可证
JSDoc 3是版权 (c) 2011年至今 Michael Mathews 缩略语@gmail.com 编辑 联合来文文件撰稿人。 。 。 .
JSDoc 3是自由软件,根据Apache许可证第2.0版获得许可. 见
文件 LICENSE.md 详情请参见此分配表.