Nikkkki's Notes


  • home

  • tags

  • categories

  • 读书

  • 电影

  • archives

代码注释规范

发表于 2021-01-09 | 分类于 学习笔记 | | 阅读次数:
字数统计: 481 字 | 阅读时长 ≈ 2 分钟

目的

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

原则

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

注释的种类

类别 内容/目的 优劣
重复性注释 只是用不同文字把代码的工作又描述一次 除了增加阅读量,没有提供更多信息
解释性注释 用于解释复杂、精巧、敏感的代码块 通常因为代码含混不清才体现出这类注释的价值
标记性注释 提醒开发者某处的工作未做完
概述性注释 将若干代码行的意思以一两句话说出来 对于修改代码的其他人来说非常有用
目的性注释 用来指明一段代码的意图,而非解决的方法
代码无法表述的信息 包括版权声明、保密要求、版本号等

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

代码命名规范

发表于 2021-01-09 | 分类于 学习笔记 | | 阅读次数:
字数统计: 2,311 字 | 阅读时长 ≈ 8 分钟

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

post.read_more »

Week 49

发表于 2020-12-06 | 分类于 Journal | | 阅读次数:
字数统计: 238 字 | 阅读时长 ≈ 1 分钟

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

image-20201206211942177

post.read_more »

Week 48

发表于 2020-11-29 | 分类于 Journal | | 阅读次数:
字数统计: 591 字 | 阅读时长 ≈ 2 分钟

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

image-20201129210729234

post.read_more »

Week 44

发表于 2020-11-01 | 分类于 Journal | | 阅读次数:
字数统计: 587 字 | 阅读时长 ≈ 2 分钟

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

image-20201101194237314

post.read_more »

Week 42

发表于 2020-10-18 | 分类于 Journal | | 阅读次数:
字数统计: 423 字 | 阅读时长 ≈ 1 分钟

好想去江之岛啊!

image-20201018220607502

post.read_more »

Week 41

发表于 2020-10-11 | 分类于 Journal | | 阅读次数:
字数统计: 779 字 | 阅读时长 ≈ 3 分钟

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

image-20201011223244842

post.read_more »

Week 33-38

发表于 2020-09-21 | 分类于 Jounal | | 阅读次数:
字数统计: 1,679 字 | 阅读时长 ≈ 6 分钟

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

image-20200921235219370

post.read_more »

Week 32

发表于 2020-08-10 | 分类于 Journal | | 阅读次数:
字数统计: 510 字 | 阅读时长 ≈ 2 分钟

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

image-20200810220602022

post.read_more »

Week 31

发表于 2020-08-03 | 分类于 Journal | | 阅读次数:
字数统计: 631 字 | 阅读时长 ≈ 2 分钟

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

image-20200803001645043

post.read_more »
12…20
Xu Quan

Xu Quan

197 state.posts
14 state.categories
125 state.tags
RSS
GitHub E-Mail Douban Weibo FreeCodeCamp Jianshu
© 2021 Xu Quan | post.totalcount: 283.5k