apidoc
apidoc
apidoc模块可以将代码中的注释转换为API文档，并生成md文件。
介绍
apidoc模块的方法
| 名称 | 类型 | 参数 | 返回值 | 说明 |
|---|---|---|---|---|
| md | 方法 | config:object | void | 生成md文件 |
注释规则
示例
/**
* 用户列表
* 获取用户列表
* @route GET /api/users
* @param {int} page - 页码。
* @param {int} size - 每页大小。
* @returns {User} 返回用户列表。
* @example
* // 获取用户列表
* fetch('/api/users?page=1&size=10', {
* method: 'GET'
* })
*/
function users(){
}
规则
- 只支持多行注释
- @route 用来标记请求方法和url地址，中间通过空格分割开
- @param 用来标记参数
- @returns 用来标记返回值
- @example 用来标记示例
md
apidoc.md(config)方法用于将代码中的注释转换为md文件
参数
md方法需要传入一个对象作为参数，该对象包含以下属性：
- dist 生成后的文档所在目录
- name md文件名
- title API文档标题
- description API文档描述
- main 主文件,系统会将该文件作为系统入口文件，将级联分析该文件引用的其他所有文件，并将这些文件内的注释转换为API文档
- files 单独的文件，系统不会分析这些文件的依赖，只会将该文件自身的注释转换为API文档
返回值
- void
示例
//导入apidoc模块
import apidoc from "apidoc"
//配置
let config={
dist:"./", //生成后的文档目录
name:"index.md", //文档名称
title:"xxx系统文档", //标题
description:"文档描述", //描述
main:[
"./index.js"
],
files:[
"./index.js"
]
}
//执行导出，会在当前文件同目录下生成md目录
apidoc.md(config)