Skip to content

Commit

Permalink
0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
yanhaijing committed Oct 10, 2018
1 parent 2a9cbe5 commit 4f1d3bd
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions doc/api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
# 文档
这是一个xxx库,有xxx功能
将对象属性递归放到目标对象,类似jQuery的`$.extend`

## api模版
## assign
函数简单介绍

函数详细介绍

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

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

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

```js
// 代码
```

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

## extend
函数简单介绍

函数详细介绍
Expand Down

0 comments on commit 4f1d3bd

Please sign in to comment.