知识卡片
名称标明意义与单位
变量名应表达存的是什么,必要时写出单位,如elapsedTimeInDays。把86400或10改成SECONDS_PER_DAY、PAGE_SIZE等有意义常量,可区分数字的不同用途并便于搜索。命名不能替代校验:常量表示固定约定时仍需确认业务和单位适用。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
int d; // 表示过去的天数 观察上面的命名,我们只能从注释中知道变量d指的是什么。如果没有注释,阅读代码的人为了知道d的含义,就不得不去寻找它的实例以获取线索。如果我们能够按照下面这样的方式命名这个变量,阅读代码的人就能够很容易地知道这个变量的含义。 int e
参考来源
- 位置:《代码精进之路:从码农到工匠(异步图书)》1.3.1 变量名(spine1;extracted/代码精进之路:从码农到工匠(异步图书)/_epub-src/OEBPS/text00000.html;u010-ch01-005)。
- 结论依据:原文在“int d;”附近的定义、实例或代码支撑本卡的核心说明:变量名应表达存的是什么,必要时写出单位,如`elapsedTimeInDays`。适用边界按该处前提解释,代码未执行。
- 原始内容:int d; // 表示过去的天数 观察上面的命名,我们只能从注释中知道变量d指的是什么。如果没有注释,阅读代码的人为了知道d的含义,就不得不去寻找它的实例以获取线索。如果我们能够按照下面这样的方式命名这个变量,阅读代码的人就能够很容易地知道这个变量的含义。 int e