命名没有痛苦的东西 我们都去过: 看着一个叫做“变数”的变量或一个叫做“函数”的函数, 并想知道原作者在想什么。
命名是编程中最困难的部分之一,但不一定是不断引起挫折的根源.
这是多年来我完善的实用方法 写和审查代码。
- "读者"的取名,不是"作家"的取名,当你点出什么来时,你正在写一篇小文件.
阅读者通常是你未来的自我,6个月后,或者是从未见过这个代码的队友.
问:"我若在真空中读出这个名字,会知道这个名字是做什么的还是代表什么的?
2.
使用有意义的区分,避免只因数字或含糊的限定词而出现不同名称。 ,,,都是红旗。
相反,要明确什么是不同的。
3.
遵循 " 最少惊喜 " 原则。
如果一个函数被调用,它应该返回一个用户,而不是更新一个.
如果一个变量叫做 .
它应该是一个布尔。
与语言公约的一致性也很重要:在大多数语言中,或前缀意味着布尔语。 4.使用正确的抽象名称级别,应当反映您工作的抽象级别.
在低级的用途,是罚款。
在商业逻辑层里,比 不要太夸张:或者很少有用.
5.
避免失信 不要使用容易被相混淆或与内置关键词相混淆的名字.
例如,而且距离太近,特别是在大型代码库中.
也避免在Python中作为可变名称使用,因为它阴影了内置类型.
6.
使用可宣布和可搜索的名称 如果无法大声说出来,在代码审查中很难讨论. (生成日期,年份,月份,日,小时,分钟,秒)是一种经典的反模式.
另外,像名字一样的名字很难被搜索,因为它们到处出现.
使用您可以独有的 grep 名称 。
7.
选取一个词汇并坚持使用。
读者会怀疑是否有微妙的区别。
为每个概念选择一个词,并在您的代码库中一致使用。 - " 布尔斯 " ,当可能的负数名称类似或更难在条件下读取时使用正数名称。
更喜欢正面的 当您需要否定时使用。
9.
别害怕重命名 如果你在代码审查时注意到一个坏名字,请修复.
若复出相而名相相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相 现代IDE使更名安全而快.
留下了不好的名字,因为"它已经存在"积累了技术债务. 10.在怀疑中,询问是否不确定什么是某事,询问队友或写出解释其所作所为的评论.
有时候,描述它的行为帮助你找到正确的名字.
你也可以使用一个占位符 就像,但不要永远离开它。
简单的高压 如果你不能在几分钟内想出一个好名字,你可能无法很好地理解问题.
退后并重新审视函数或变量的真正作用.
通常,一旦你澄清了意图,就会出现一个好名字.
取名是技能,不是才华.
通过练习和故意,你可以写出代码,读来像一个结构完善的故事.
你的未来会谢谢你的 更多关于这个话题,请查看罗伯特·C·马丁所著的"Clean Code"经典一书,该书有关于有意义的名字的一整章.
此外,Google Style Guides还提供了值得遵循的特定语言命名惯例.