知识卡片
注释解释意图
注释应补充代码背后的原因和约束,而非复述语句。把“等待2秒”改为“等待关联系统处理结果”,才解释了目的;若函数名已清楚表达目的,可减少重复注释。改名不代表固定等待可靠,也不代表吞掉中断合理;表达问题和行为正确性需要分别检查。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 注释解释意图
原书出处 · 1 处
- · 查看原书依据
注释要能够解释代码背后的意图,而不是对功能的简单重复。例如,我们在一个系统中看到如下代码: try { //在这里等待2秒 Thread.sleep(2000); } catch (InterruptedException e) { LOGGER.error(e); }
参考来源
《代码精进之路:从码农到工匠(异步图书)》第1章《命名》
- 位置:《代码精进之路:从码农到工匠(异步图书)》1.5.3 小心注释(spine1;extracted/代码精进之路:从码农到工匠(异步图书)/_epub-src/OEBPS/text00000.html;u024-ch01-003)。
- 结论依据:原文在“注释要能够解释代码背后的意图”附近的定义、实例或代码支撑本卡的核心说明:注释应补充代码背后的原因和约束,而非复述语句。适用边界按该处前提解释,代码未执行。
- 原始内容:注释要能够解释代码背后的意图,而不是对功能的简单重复。例如,我们在一个系统中看到如下代码: try { //在这里等待2秒 Thread.sleep(2000); } catch (InterruptedException e) { LOGGER.error(e); }