知识卡片
坏名字应先改好
当注释大半用于澄清一个模糊或误导性的名字,应先考虑把澄清信息放进名字。名字会出现在每个使用位置,读者不用回到定义才知道真实行为。例如释放注册表句柄不等于删除注册表,名称应体现区别;改名后仍可保留无法由名称承载的边界与背景。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 坏名字应先改好
原书出处 · 1 处
- · 查看原书依据
更加“自我说明”了。一个好的名字比一个好的注释更重要,因为在任何用到这个函数的地方都能看得到它。 下面是另一个例子,给名字不大好的函数加注释: DeleteRegistery()这个名字听起来像是一个很危险的函数(它会删除注册表?!)注释里的“它不会改动真正的注册表”是
参考来源
- 位置:《编写可读代码的艺术》用改名解决命名造成的困惑(spine 2795;来源项目book-sources,`extracted/OReilly精品图书系列共21册(《Javascript权威指南》、《机器学习:实用案例解析》、《编写可读代码的艺术》、《算法精解》等)/_epub-src/text/part2719.html`;来源键`s2795-ch05-002`)。
- 结论依据:正文与图103..131完整实读;示例的性能数字、参数及实现细节限定于原例,没有执行或推广为当前通用保证。
- 原始内容:更加“自我说明”了。一个好的名字比一个好的注释更重要,因为在任何用到这个函数的地方都能看得到它。 下面是另一个例子,给名字不大好的函数加注释: DeleteRegistery()这个名字听起来像是一个很危险的函数(它会删除注册表?!)注释里的“它不会改动真正的注册表”是