利用JS注释自动生成api文档神器 — jsdoc

利用JS注释自动生成api文档神器 — jsdoc利用JS注释自动生成api文档神器—jsdoc安装运行注释文档格式安装1、第一种方法:全局安装jsdoc:npminstall-gjsdoc2、第二种方法:cd到项目路径下,在项目中局部安装jsdoc:npminstall–save-devjsdoc参考:https://github.com/jsdoc/jsdoc运行1、全局安装jsdoc时运行:jsdoc你的js文件.js2、局部安装jsdoc时运行:./node_modules/.bin/

利用JS注释自动生成api文档神器 — jsdoc

安装

1、第一种方法:全局安装jsdoc:

npm install -g jsdoc

2、第二种方法:cd到项目路径下,在项目中局部安装 jsdoc:

npm install –save-dev jsdoc

参考 :https://github.com/jsdoc/jsdoc

运行

1、全局安装jsdoc时运行:

jsdoc 你的js文件.js

2、局部安装 jsdoc时运行:

./node_modules/.bin/jsdoc 你的js文件.js

运行后生成文件
运行后生成文件结构

注释文档格式

参考 :https://www.html.cn/doc/jsdoc/tags-author.html

js中注释写法
在这里插入图片描述

api文档生成后的格式
在这里插入图片描述

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/11051.html

(0)
编程小号编程小号

相关推荐

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注