编程规约—代码命名风格

编程规约—代码命名风格

因为软件是需要人来维护的。这个人在未来很可能不是你。所以首先是为人编写程序，其次才是计算机。所以一个好的编程习惯是非常重要的，这里简述一下代码的命名风格。

• 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
• 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
• 类名使用UpperCamelCase风格，但以下情形例外：DO / BO / DTO / VO / AO / PO等。
• 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
• 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
• 抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；
• 测试类命名以它要测试的类名开始，以Test结尾。
• 类型与中括号紧挨相连来定义数组。
• POJO类中布尔类型的变量，都不要加is前缀，否则部分框架解析会引起序列化错误。
• 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
• 杜绝完全不规范的缩写，避免望文不知义。
• 最好逐一声明每个变量而不是写在一行。
• Java的变量声明尽量靠近变量第一次使用的地方。