目的

• 注释是为了让读代码的人和写代码的人对代码的了解一样多
• 随着鱼塘业务复杂性的增加，代码中关于业务的内容不应只存在于写代码的人脑子里，而应该通过注释保留在代码中
• 提高代码的可维护性，减少团队协作的沟通成本

原则

• 注释应注重”为何做（why）“而不是”怎么做（how）“
• 如果你发现自己需要写注释，再想想是否有办法翻盘，用代码来表达，很多时候，只要创建一个描述与注释所言同一事物的函数即可；如果最终决定要写注释，就要花必要的时间确保写出最好的注释ÏÏ
• 注释存在的时间越久，就离其所描述的代码越远，越来越变得全然错误；因此，程序员应当负责将注释保持在可维护、有关联、精确的高度

注释的种类

对于完工的代码，只允许有三种注释类型：代码无法表述的信息、目的性注释和概述性注释

最近读《代码简洁之道》、《代码大全》和《编写可读代码的艺术》总结了一些通用的内容，作为团队代码的规范。

提前拿到生日礼物，是 1988 的签名照。对着签名照感动地流了一会儿泪。想跟自己说，你不要担心啊。

又偷懒了一个月，这一个月不知怎么地开始进入一种自我怀疑的情绪中，导致很多事情都没有做到很好。

得赶紧抓住秋天的尾巴了。

好想去江之岛啊！

前两周的周记一直没能发出来，命令行一直报错，后来才发现 autojump 进入的文件夹是备份之前的，有些文件缺失了，但是自己一直没发现。

以为只是漏掉了两三周的周记，今天看日期才知道，居然不知不觉就过了 5 周。

热的夏天让人窒息，但是突然暴雨后的夏天又有股迷人的气息，让人想起南方。最近很想回武汉。

今年年初开始疫情，然后一直持续到现在。虽然全世界的形势都变得异常诡异，但这是难得的有近半年时间我都几乎没怎么焦虑，回想起来大部分时光都是开心的。上周算是非常少见的焦虑状态，主要原因是 ddl 太近，而活儿太多，感觉自己就要拖后腿。