知识卡片

普通读书笔记卡 · 1713.e

约定命名胜过冗长命名

理解等级:未标注

好名字要让人推测出大致作用,但不必因此变长:i(数组索引)、x(横坐标)、T(类型参数)等约定俗成的短名字已够清晰。类名用名词、方法名用动词、不用非标准缩写更通用。字段命名如salary/s信息太少,employeeMonthlySalary重复类名信息,monthlySalary才恰好。发散:判断标准是”够不够用”而非”够不够长”,[[提取变量降负担]]同理。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《你真的会写代码吗-2021》第7章《让代码说话:可读性》"7.3.2 命名"(源文件:_epub-src/OEBPS/Text/0017.xhtml) - 结论依据:原文明确"名字应该是描述性的……这并不一定意味着名字必须很长",并逐一举例`i`、`x`、`T`等约定俗成短名字为何足够清晰,再用`salary`/`s`/`monthlySalary`/`employeeMonthlySalary`的字段命名小测验说明信息过少或冗余重复都不理想。 - 原始内容:名字应该是描述性的,这样不熟悉代码的读者至少可以根据命名推测出元素的大致作用。这并不一定意味着名字必须很长……小测验4:给Employee类中保存月薪的字段命名,用salary、s、monthlySalary和employeeMonthlySalary中的哪个更好?