一些未注意到的命名规范

1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

   反例:_name / __name / $Object / name_ / name$ / Object$

2. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用。
   正例:alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。 反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3 

1. 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO / DTO / VO / AO
   正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 

   7.【强制】中括号是数组类型的一部分,数组定义如下:String[] args; 反例:使用String args[]的方式来定义。

   10. 【强制】杜绝完全不规范的缩写,避免望文不知义。
   反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性。 

   11. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。
   正例:从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。
   反例:变量 int a; 的随意命名方式。 

    

   2. 【强制】long 或者 Long 初始赋值时,使用大写的 L,不能是小写的 l,小写容易跟数字 1 混 淆,造成误解。
   说明:Long a = 2l; 写的是数字的21,还是Long型的2? 

    

   1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则:

      1) 左大括号前不换行。
      2) 左大括号后换行。
      3) 右大括号前换行。
      4) 右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。 

   1. 【强制】 左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格。详见 第 5 条下方正例提示。
      反例:if (空格a == b空格) 

    

   1. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。 

   1. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。

      说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。 

    

   6. 【强制】注释的双斜线与注释内容之间 正例:// 注释内容,注意在和

     一个空格。
   之间有一个空格。
   

   8. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。

   正例:下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c"); 

   1. 【强制】所有的覆写方法,必须加@Override 注解。
      说明:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编 译报错。