如何写缓存文档

作者: 雨果僧 | 来源:发表于2017-09-13 17:23 被阅读5次

    在一个工程里面,除了要撰写必要的api文档之外,还需要对其他的数据结构进行描述,而缓存文档就是其中之一。

    在我的工程历练里面,Redis用得相对较多,所以下面的板式主要是以它为主,但本质的理念是一致的,就是文档化你的数据。

    格式如下:


    # 缓存文档
    
    ## task结构
    ```
    key: task:$task_id
    type: hmap
    transmit_num: 200 // 转发阅读数
    ```
    
    ## 任务列表结构
    ```
    key: task_to_read
    type: zset
    $task_id:$time
    ```

    相关文章

      网友评论

        本文标题:如何写缓存文档

        本文链接:https://www.haomeiwen.com/subject/ckklsxtx.html