知识卡片
注释应把常量与原因对应起来
缓冲长度公式里的+1、×3和+200若各有设计原因,应让读者知道每项分别代表什么以及适用条件。笼统说“像素、过滤字节和头部”仍不能准确对应公式,反而使人继续猜。可用有意义的命名或精确说明解释,不能仅因为数字被一段长注释包住就认为容量计算已正确。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
- · 第4章 注释
原书出处 · 1 处
参考来源
- 位置:《代码整洁之道》全书 · 第4章 注释,spine013单元010;来源项目book-sources,extracted/代码整洁之道/_epub-src/OEBPS/Text/part0011.xhtml。
- 结论依据:原文PNG分配表达式旁连问各项对应关系,直接支持注释需要定位具体事实;没有给答案,故未补造图像格式常量解释。未在本机运行示例或改变环境。
- 原始内容:系吗?或与*3 有关?还是与两者皆有关?为什么用200?注释的作用是解释未能自行解释的代码。如果注释本身还需要解释,就太遗憾了。 4.4.17 函数头 短函数不需要太多描述。为只做一件事的短函数选个好名字,通常要比写函数头注