如何寫緩存文檔

在一個(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
```
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,062評(píng)論 25 709
  • 分布式緩存技術(shù)PK:選擇Redis還是Memcached? 經(jīng)平臺(tái)同意授權(quán)轉(zhuǎn)載 作者:田京昆(騰訊后臺(tái)研發(fā)工程師)...
    meng_philip123閱讀 69,046評(píng)論 7 60
  • 黑夜里的風(fēng)像一條潺潺的小河 你不知道他的來處 也不知他的歸宿 我想見見你 那悠悠的小舟 漁夫的蓑衣沒有淋濕雨 他借...
    太陽系的星閱讀 166評(píng)論 0 0
  • 從2010年我們紅十字醫(yī)院建立康復(fù)科康復(fù)中心開始,我的專業(yè)從一名內(nèi)科醫(yī)生像一名康復(fù)??漆t(yī)生轉(zhuǎn)變。這對(duì)于我來說不是一...
    Doctor陳閱讀 627評(píng)論 0 2
  • 當(dāng)對(duì)象的狀態(tài)改變時(shí),同時(shí)改變其行為 這讓我想到了iOS 中按鈕不同狀態(tài),綁定不同的方法和不同的title等~~ 狀...
    風(fēng)___________閱讀 221評(píng)論 0 0

友情鏈接更多精彩內(nèi)容