【文件属性】:
文件名称:jsdoc:JavaScript的API文档生成器
文件大小:954KB
文件格式:ZIP
更新时间:2021-01-30 13:21:49
javascript api documentation docs jsdoc
JSDoc
用于JavaScript的API文档生成器。
想要为JSDoc做贡献吗? 请阅读CONTRIBUTING.md 。
安装及使用
JSDoc支持稳定版本的Node.js 8.15.0及更高版本。 您可以全局安装JSDoc或在项目的node_modules文件夹中安装。
要在npm上全局安装最新版本(可能需要sudo ; ):
npm install -g jsdoc
要在本地npm上安装最新版本并将其保存在软件包的package.json文件中:
npm install --save-dev jsdoc
注意:默认情况下,npm使用插入号运算符在版本号之前添加软件包(例如^3.6.3 )。 我们建议改用波浪号运算符(例如~3.6.3 ),该操作将更新限制为最新的补丁程序级别版本。 请参阅,以获取有关插入符号和代字号运算符的更多信息。
如果在本地安装了JSDoc,则./node_modules/.bin提供了JSDoc命令行工具。 要为文件yourJavaScriptFile.js生成文档:
./node_modules/.bin/jsdoc yourJavaSc