在一個(gè)工程里面,除了要撰寫必要的api文檔之外,還需要對(duì)其他的數(shù)據(jù)結(jié)構(gòu)進(jìn)行描述,而緩存文檔就是其中之一。
在我的工程歷練里面,Redis用得相對(duì)較多,所以下面的板式主要是以它為主,但本質(zhì)的理念是一致的,就是文檔化你的數(shù)據(jù)。
格式如下:
# 緩存文檔
## task結(jié)構(gòu)
```
key: task:$task_id
type: hmap
transmit_num: 200 // 轉(zhuǎn)發(fā)閱讀數(shù)
```
## 任務(wù)列表結(jié)構(gòu)
```
key: task_to_read
type: zset
$task_id:$time
```