Java代码规范之命名
软件中随处可见命名。我们给变量、函数、参数、类和包命名。我们给源代码及源代码所在目录命名。命名规范有助于提高效率和提升代码可读性,在此记录一些命名的规范和技巧,详细的可以参见《代码整洁之道》
有意义的命名
- 名副其实,见名知意
变量名太随意,haha
、list1
、ok
、theList
这些都无意义 - 避免误导
- 包含List、import、java等类名、关键字或特殊字;
- 字母o与数字0,字母l与数字1等
- 提防使用不同之处较小的名称。比如:
XYZControllerForEfficientHandlingOfStrings
与XYZControllerForEfficientStorageOfStrings
- 做有意义的区分
- 反面教材,变量名:a1、a2、a3
- 避免冗余,不要出现
Variable
、表字段中避免出现table
、字符串避免出现nameString
- 使用读得出来的名称
- 不要使用自己拼凑出来的单词,比如:
xsxm
(学生姓名);genymdhms
(生成日期,年、月、日、时、分、秒) - 所谓的驼峰命名法,尽量使用完整的单词
- 不要使用自己拼凑出来的单词,比如:
- 使用可搜索的名称
一些常量,最好不直接使用数字,而指定一个变量名,这个变量名可以便于搜索到.
比如:找MAX_CLASSES_PER_STUDENT
很容易,但想找数字7就麻烦了。 - 避免使用编码
- 匈牙利语标记法:即变量名表明该变量数据类型的小写字母开始。例如,
szCmdLine
的前缀sz
表示“以零结束的字符串”。 - 成员前缀:避免使用前缀
- 接口和实现:作者不喜欢把接口使用I来开头,实现也希望只是在后面添加Imp
- 匈牙利语标记法:即变量名表明该变量数据类型的小写字母开始。例如,
- 避免思维映射
比如传统上惯用单字母名称做循环计数器。所以就不要给一些非计数器的变量命名为:i、j、k等 - 类名:类名与对象名应该是名词与名词短语。如Customer、WikiPage、Account和AddressParser。避免使用Data或Info这样的类名。
不能使动词。比如:Manage、Process - 方法名:方法名应当是动词或者动词短语。如
postPayment
、deletePage
- 每个概念对应一个词:项目中同时出现controllers与managers统一使用其中一种
- 别用双关语:有时可能使用add并不合适,比如insert、append。add表示完整的新添加的含义。
- 使用解决方案领域名称:尽量用计算机科学术语、算法名、模式名、数学术语,依据问题所涉领域来命名不算是聪明的做法。
- 使用源自所涉问题领域的名称:如果不能用程序员熟悉的术语来给手头的工作命名,就采用从所涉问题领域而来的名称。
- 添加有意义的语境:可以把相关的变量放到一个类中,使用这个类来表明语境。
- 不要添加没用的语境:名字中带有项目的缩写,这样完全没有必要。比如有一个名为“加油站豪华版”(Gas Station Deluxe)的项目,在其中给每个类添加GSD前缀就不是什么好策略。
- 取好名字最难的地方在于需要良好的描述技巧和共有文化背景。
Java中的名称命名规范
- 包名:多单词组成时所有字母都小写:
xxxyyyzzz
- 类名、接口名:多单词组成时,所有单词首字母大写:
XxxYyyZzz
- 变量名、方法名:多单词组成时,第一个单词首字母小写,第二个单词开始每个单词首字母大写:
xxxYyyZzz
- 常量名:所有字母都大写,多单词时每个单词用下划线连接:
XXX_YYY_ZZZ