day_6/29(java命名规范和编码规范)

一、命名规范

        1、代码中的命名均不要以下划线或美元符号开始或结束，也不要用拼音和英文混合的方式命名；

        2、类名的所有单词都要首字母大写，如 MarcoPolo /  UserDO /  XmlService等；

        3、方法名、参数名、成员变量或者局部变量都统一使用第一个单词全部小写，后面根的单词首字母大写的方式命名。

        4、常量名就需要所有字母大写，单词与单词之间用下划线隔开就可以了

        5、抽象类命名要使用 Abstract 或 Base 开头 ； 异常类命名使用 Exception 结尾 ； 测试类命名以它要测试的类的名称开始，以 Test 结尾。

        6、中括号是数组类型的一部分，数组定义以下： String[] args;反例：使用 String args[] 的方式来定义。

        7、包名统一使用小写，点分隔符之间有且仅有一个天然语义的英语单词。

        8、杜绝彻底不规范的缩写，避免望文不知义。应为这样会严重下降代码的可读性。

        9、接口类中的方法和属性不要加任何修饰符号 （public 也不要加 ） ，保持代码的简洁性，并加上有效的 Javadoc 注释。

        10、枚举类名建议带上 Enum 后缀，枚举成员名称须要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。正例：枚举名字： DealStatusEnum， 成员名称： SUCCESS /  UNKOWN _ REASON 。

二、编码规范

               在学习和开发的过程中要养成良好的编码规范，因为规整的代码格式会给程序的开发和日后的维护提供很大方便。总结的编码规范如下：

        1、每条语句要单独占一行。虽然Java语言中可以在一行当中写几条语句，但为了程序看起来更加规范，且便于维护，要养成每行只写一条语句的好的编码规范。

        2、每条命令都要以分号结束。语句要以分号结尾，程序代码中的分号必须为英文状态下的，初学者经常会将“;”写成中文状态下的“；”，此时编译器会报出 illegal character (非法字符)这样的错误信息。

        3、声明变量时要分行声明。即使是相同的数据类型也要将其放置在单独的一行上，这样有助于添加注释。

        4、Java语句中多个空格看成一个。在Java代码中，关键字与关键字间如果有多个空格，这些空格均被视作一个。

        5、不要使用技术性很高、难懂、易混淆判断的语句。由于程序的开发与维护不能是同一个人，为了程序日后的维护方便，应尽量使用简单的技术完成程序需要的功能。

        6、对于关键的方法要多加注释。多加注释会增加程序的可读性，有助于阅读者很快地了解代码结构。