1,JSDoc安装
npm install jsdoc -g
2.指定文件生成文档
jsdoc xxx.js
3.配置项
参数 | 全称 | 说明 |
---|---|---|
-c | –configure | 引入配置项,默认为 jsdoc 安装目录的 config.json 文件 |
-d | –destination | 配置文档输出的目录,默认为 ./out |
-P | –package | 可以将 package.json 文件写入文档中,默认写入当前路径的第一个 package.json |
-r | –recurse | 递归调用路径的子目录查找 js 文件,当生成一个文件夹下的全部 js 的文档时必须使用这个参数 |
-R | –readme | 可以引入一个说明文件,默认将当前路径中的第一个 readme.md 文件添加到文档中 |
-t | –template | 可以给文档指定一个第三方的模板 |
eg.
将 ./src 路径下的所有 js 文件生成文档,然后存放在 ./docs 文件夹中
jsdoc src -r -d docs
4.js文件注释规范
1.注释必须以/**
开头
2.标签说明
标签 | 说明 |
---|---|
@alias | 同名引用,用于指定一个同名属性或在非显示的情况下标明从属关系,详见下节 |
@author | 说明这篇代码谁写的,方便出 bug 的时候削人 |
@class @constructor | 标记一个函数为构造函数,可以使用 new 来实例化 |
@constant @const | 将一个变量标记为常量 |
@description @desc | 进行描述,一般会把注释开头的文字默认作为描述 |
@enum | 标注一个对象为枚举对象 |
@example | 可以给文档提供一个如何使用的例子 |
@file @fileoverview @overview | 表示对一个文件的描述 |
@global | 标记一个全局变量 |
@param | 标记一个函数的参数 |
@returns @return | 标记一个函数的返回值 |
@this | 标注一个 this 关键字的指向 |
参考链接1:https://jsdoc.app/
参考链接2:http://malcolmyu.github.io/malnote/2015/04/25/Introduction-of-Jsdoc/