3. 【更推荐】为了让代码能够直接通过类名、方法名、变量名等名称读懂,任何自定义编程元素在命
名时,使用尽量完整的单词组合来表达其意,即便这会使命名很长也无所谓。
说明:一句话,起名字的时候害怕不能“见名知意”,但就是不害怕很长的名字。
正例:比如工具类中有多个获取最大值的方法,要通过方法名说清楚各自的区别。
getMaxValueByArray、getMaxValueByScanner等
反例:直接统统叫getMax、定义一个方法的局部变量叫a等
4. 【强制】常量命名全部大写,单词间用下划线隔开,命名可以很长,但是不能不清不楚。
正例:MAX_STOCK_COUNT
反例:maxValue、MAX
特殊要求
在某些特殊的场景,有一些特殊的命名要求
1. 【更推荐】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类
命名以它要测试的类的名称开始,以 Test 结尾。
2. 【更推荐】布尔类型的变量,一律禁止使用is前缀的形式,否则会引起某些框架的解析错误
说明:对于成员变量isMale而言,它的get方法也会写成isMale()。对于某些RPC框架而言,会将该
属性误解析为male而获取不到,这样就会抛出异常。
反例:最典型的就是定义性别时,使用“isMale”或者“isFemale”
注释规范
注释的使用在Java中是十分重要的,在公司中写好注释,可以给人留下极好的映像~
1. 【更推荐】单行注释的双斜线与注释内容之间有且仅有一个空格。
说明:阿里巴巴的规范中,单行注释要求双斜线后面必须有且仅有一个空格。坊间传闻这是阿里的
脚本检查代码格式时的要求,应该不太具有实际意义。实测下来,双斜线后加一个空格,注释的阅
读性会更好,大家可以模仿一下。
正例:
2. 【更推荐】建议类添加创建者和创建日期,也要指明该类的大致设计思路和用途。
3. 【更推荐】属性和方法如有必要添加注释,必须使用 Javadoc 规范,即使用文档注释/** 内容 */的
形式,禁止使用单行/多行注释的形式。一般来说,属性很少需要注释或者仅需要极少注释,但方
法普遍都需要注释。
说明:关于以上注释的具体格式会在文档最后详细说明,请查看完规范再翻看。
4. 【更推荐】方法内部如有说明注释的需求,请使用单行/多行注释,放在在被注释语句的上面而不
是下面。
说明:注释语句注意与代码对齐。