第 1 章 命名

《代码精进之路 从码农到工匠》学习笔记目录

原书:《代码精进之路 从码农到工匠》 | 作者:张建飞

1.3.3 类名

对于辅助类,尽量不要用 Helper、Util 之类的后缀,因为其含义太过笼统,容易破坏 SRP(Single responsibility principle 单一职责原则)。

比如对于处理 CSV,可以这样写:

1
2
CsvHelper.parser(String)
CsvHelper.create(int [])

但更建议将 CsvHelper 拆开

1
2
CsvParser.parser(String)
CsvBuilder.create(int [])

1.4.3 后置限定词

很多程序中会有表示计算结果的变量,例如总额、平均值、最大值等。如果你要用类似 Total、Sum、Average、Max、Min 这样的 限定词来修改某个命名,那么记住把限定词加到名字的最后

优点

变量名中最重要的部分是表达主要含义,应位于最前面,这样可以突出显示,并被首先阅读到。

Licensed under CC BY-NC-SA 4.0
comments powered by Disqus