Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 567 Bytes

api.md

File metadata and controls

24 lines (17 loc) · 567 Bytes

文档

这是一个xxx库,有xxx功能

api模版

函数简单介绍

函数详细介绍

函数参数和返回值(要遵守下面的例子的规则)

  • param {string} name1 name1描述
  • param {number} [name2] name2描述 ([]代表可选参数)
  • param {string|number} name3 name3描述 (| 代表多种类型)
  • param { * } name3 name3描述 (*代表任意类型)
  • param {boolean} obj.sex 复合参数定义
  • return {string} 返回值描述

举个例子(要包含代码用例)

// 代码

特殊说明,比如特殊情况下会报错等