编写可读代码的艺术(四)注释的“艺术性”
2018-02-23 22:40
375 查看
注释的关键思想是为了尽量帮助读者了解得跟作者一样多
那什么时候用到注释，什么时候不用到注释呢？
答案其实很简单，只要能从代码本身迅速推断出事实就没必要写注释，或者遇到不好的名字时而为它写注释，而是想方设法更好这个名字，即好代码>坏代码+好注释，这是不需要注释的场景
当有段代码写成这样而不是那样的时候，需要一种注释其中的缘由（即指导性批注）
遇到代码有缺陷时也应该加上TODO或者XXXX这类的标志
定义一个常量的时候，可以注释其中的内部背景
为普通读者遇到的意外的地方加上注释
用注释总结代码块，以防读者迷失在细节中
那如何写好言简意赅的注释呢？
注释应该写越明确和细节越好，且注意注释的紧凑性（即注释应当有很高的信息率和空间率）
那什么时候用到注释，什么时候不用到注释呢？
答案其实很简单，只要能从代码本身迅速推断出事实就没必要写注释，或者遇到不好的名字时而为它写注释，而是想方设法更好这个名字，即好代码>坏代码+好注释，这是不需要注释的场景
当有段代码写成这样而不是那样的时候，需要一种注释其中的缘由（即指导性批注）
遇到代码有缺陷时也应该加上TODO或者XXXX这类的标志
定义一个常量的时候，可以注释其中的内部背景
为普通读者遇到的意外的地方加上注释
用注释总结代码块，以防读者迷失在细节中
那如何写好言简意赅的注释呢？
注释应该写越明确和细节越好，且注意注释的紧凑性（即注释应当有很高的信息率和空间率）
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- 编写可读代码的艺术读书笔记--审美与注释
- 编写可读代码的艺术 读后感(一)
- 读书笔记-编写可读代码的艺术[上]
- 编写可读代码的艺术 读后感(二)
- 读书笔记-编写可读代码的艺术[下]
- 编写可读代码的艺术chapter 1-6
- 读书笔记-编写可读代码的艺术[上]
- 编写可读代码的艺术 读后感(三)
- 读书笔记-编写可读代码的艺术[上]
- 读书笔记-编写可读代码的艺术[上]
- 编写可读代码的艺术
- 读书笔记-编写可读代码的艺术[中]
- 编写可读代码的艺术
- O’Reilly精品图书系列：编写可读代码的艺术（奋斗的小鸟）_PDF 电子书
- 编写可读代码的艺术（第一部分）
- 编写可读代码的艺术（第二部分 简化循环和逻辑）
- 读书笔记-编写可读代码的艺术[中]
- 【编写可读代码的艺术】第一部分 表面层次的改进
- 编写可读代码艺术笔记
- 读书笔记-编写可读代码的艺术[中]