阿里的java文档的规范

阿里的java文档的规范

我自己写一遍，加强印象。方便后期的学习。

---

编程规范

命名规约

1. 所有编程相关命名均不能以下划线或 美元符号开始，也不能以下划线或美元符号结束。
2. 所有编程相关的命名严谨使用拼音与英文混合的方式，更不允许直接使用中文的方式。
   *说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用
3. 类名使用UpperCameCase风格，必须遵从驼峰形式，但一下情形例外：（领域模型的相关命名）DO／DTO／VO／DAO等。
   *MarcoPolo／UserDO／XmlService／TcpUdpDeal／TaPromotion
4. 方法名、参数名、成员变量、局部变量都统一使用lowerCameCase风格，必须遵从驼峰形式。
   *localValue／getHttpMessage／inputUserId
5. 常量名称全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
6. 抽象类命名使用Abstact或Base开头；异常类命名使用Exception结尾，测试类命名以它要测试的类的名称开始，以Test结尾。
7. 中括号是数组类型的一部分，数组定义如下：String[]args;
8. POJO类中的任何布尔类型的变量，都不要加is，否则部分架构解析会引起序列化错误。
9. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如有复数含义，类名可以使用复数形式。
10. 杜绝完全不规范的缩写，避免望文不知义。
11. 如果使用到了设计模式，建议在类名中体现出具体模式。
12. 接口类中的方法和属性不要加任何修饰符号，保证代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义常量，如果一定要定义变量，肯定与接口方法相关，并且是整个应用的基础变量。
    *接口方法签名：void f(); 接口基础常量表示：String COMPANY=”alibaba”。
13. 接口和实现类的命名有两套规则：
    1 对于service 和dao类，基于soa的理念，暴露出来的服务一定是接口，内部的视线类用Imple的后缀于接口区别。
    2 如果是形容能力的接口名称，取对应的形容词做接口名。（通常是-able的形式）
14. 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
    15.各层命名规约：
    server／dao层方法命名规约
    1获取单个对象的方法用get做前缀。
    2获取多个对象的方法用list做前缀。
    3获区统计值的方法用count做前缀。
    4插入的方法用save做前缀。
    5删除的方法用remove做前缀。
    6修改的方法用update做前缀。

常量定义

1. 不允许出现任何魔法值（即未经定义的常量）直接出线在代码中。
   
   • 反例：String key=”Id#taobao_”+tradeId; cache.put(key,value);
2. long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
3. 不要睡用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下／
4. 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
   
   1. 跨应用共享常量：放置在二方库中，通常是client.jar中的const目录下。
   2. 应用内共享常量：放置在一方库的modules中的const目录下。
   3. 子工程内不共享常量：即在当前工程的const目录下。
   4. 包内共享常量：即在当前包下单独的const目录下。
   5. 类内共享常量：直接在类内部pivate static final定义。
5. 如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。
   *正例：public Enum{MONDAY(1),TUESDAY(2),WEDNESDAY(3),THURSDAY(4),FRIDAY(5),SATURDAY(6),SUNDAY(7);}

格式规约

1. 大括号的使用约定。如果是大括号内为空，则简介地写成{}即可，不需要换行；如果是非空代码块则：
   1 左大括号前不换行。
   2 左大括号后换行。
   3 右大括号前换行。
   4右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

2. 左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。

3. if／for／while／switch／do等保留字与左右括号之间都必须要加空格
4. 任何运算符左右必须加一个空格。
5. 代码块缩进4个空格，如果使用tab锁进，请设置成1各tab为4个空格。

6. 单行字符数限制不超过120个，超出需要换行，换行时，遵循如下原则：
   1换行时相对上一行缩进4个空格。
   2运算符与下文一起换行。
   3方法调用的点符号与下文一起换行。
   4在多个参数超长，逗号后进行换行。
   5在括号前不要换行。

7. 在方法参数在定义和传入时，多个参数逗号后边必须要加空格。

8. 没有必要添加若干空格来使某一行的字符与上一行的相应字符对齐。
9. IDE的text file encoding设置为UTF-8，IDE中文件的换行符使用Unix格式，不要使用window格式。
10. 方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
    *说明：没有必要插入多行空格进行隔开。

oop规约

1. 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编辑器解析成本，