编写说明文档

说明文档

基线版5.0用的是docsify生成的
docsify文档: https://docsify.js.org/#/

js工具库转API文档:jsdoc2md

使用方法

安装依赖
npm install
运行
node ./docs.js
配置输入js文件路径,输出md文件路径(docs.js)
const inputFile = 'D:\path\to\input\folder'
let docsDir = path.resolve('D:\path\to\output\folder')

工具库js文件标准写法

标题和namespace,标题作为md的标题,namespace作为生成md的文件名
/**
 * 新手引导API
 * @namespace guide
*/
方法的注释里记得要加@memberof namespace,不然生成API文档中不包含该方法
/**
* 根据组件位置决定新手引导图片位置
* @param {Array} options 选项
* @param {String} options.ref ref对象名(ref为空则默认新手引导显示在top: 0)
* @param {String} options.rect 新手指导图片显示在ref对象的哪个布局位置(默认bottom)
* @param {Function} callback 回调函数
* @memberof guide
*/