知识卡片
可读性3C规则
可读性常被忽略却关键——难懂的代码对所有人(包括作者)都难懂。定义可读性的 3C 规则:注释(Comment,强制且有意义,禁止明显注释,注释是“蛋糕上的糖衣”而非蛋糕本身)、一致性(Consistency,团队遵守统一编码指导原则,避免让读者因风格差异反复回看)、清晰性(Clarity,适当分组、限制 IF 数量、善用 SWITCH、用空行分块)。可读性关乎尊重与金钱。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 编写优质软件 · 查看原书依据
某种3C规则可以用来定义可读性:注释(Comment),一致性(Consistency)和清晰性(Clarity)。
参考来源
- 位置:《Microsoft.NET企业级应用架构设计(第2版)(异步图书)》第04章《编写优质软件》(源文件:extracted/Microsoft.NET企业级应用架构设计(第2版)(异步图书)/_epub-src/OEBPS/text00010.html)
- 结论依据:原文明确阐述该主题,并给出定义、实践或反例。
- 原始内容:某种3C规则可以用来定义可读性:注释(Comment),一致性(Consistency)和清晰性(Clarity)。