知识卡片
注释补充代码未表达的逻辑
可读性来自贴切命名、清楚结构和有帮助的说明。代码已直接表达的操作不必再逐字复述;注释更应帮助其他开发者理解不明显的逻辑或意图。
“自注释”不是完全不要注释,也不是命名长就自动清楚。判断标准是读者能否理解目标与约束,不能仅以注释数量衡量质量。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
编写自注释的代码,这都是一些范例。关于如何编写好的注释,各种不同的观点之间相差很大。但一个好的基本准则是加上注释以便于其他的开发人员能够很容易地通过阅读这段注释来理解程序逻辑。另一方面,如果代码是自注释的则不需要添加注释,因为代码读起来几乎和注释一样清楚明了。本书中的自注释代码例子是在头文件中对给出
参考来源
- 位置:《算法精解:C语言描述》第1章《小酌软件工程》(spine1181;extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part1149.html;u017-ch01-010)。
- 结论依据:17可读性段比较有意义注释、贴切标识符和自注释代码,明确已足够清楚处不必添注;卡片保留阅读目标而非数量要求。
- 原始内容:编写自注释的代码,这都是一些范例。关于如何编写好的注释,各种不同的观点之间相差很大。但一个好的基本准则是加上注释以便于其他的开发人员能够很容易地通过阅读这段注释来理解程序逻辑。另一方面,如果代码是自注释的则不需要添加注释,因为代码读起来几乎和注释一样清楚明了。本书中的自注释代码例子是在头文件中对给出