【文件属性】:
文件名称:文档:现代JavaScript文档
文件大小:1.59MB
文件格式:ZIP
更新时间:2021-01-29 17:07:56
javascript documentation babel jsdoc documentation-tool
现代JavaScript的文档系统
支持现代JavaScript:ES5,ES2017,JSX,Vue和类型注释。
推断参数,类型,成员资格等。 写更少的文档:让计算机为您编写。
与GitHub集成以直接从文档链接到它所引用的代码。
可自定义的输出:HTML,JSON,Markdown等
例子
文献资料
:从这里开始
:如何使用documentation.js
:编写有效的JSDoc文档的技巧
:documentation.js的自生成文档
:主题化HTML文档输出的技巧
:类似于documentation.js的项目列表
用户指南
使用软件包管理器全局安装documentation :
$ npm install -g documentation
这将在您的路径中安装一个称为documentation的命令,您可以指向源代码以生成易于阅读的文档。 首先,使用--help选项运行documentation以获取帮助:
Usage:
# generate markdown docs for index.js and files it references
docume