JAVA研发前传（1）代码规范性

1、标识符命名规范

（1.1）原则：统一、达意、简洁

=============         1.1.1、 统一：名称统一              =============

例如：user    /    username，意思差不多，不能一会用user，一会儿用username

=============          1.1.2、达意：准确详细              =============

例如:  比起 user1 / user2 ，显然clientUser / serverUser 更能达意

=============          1.1.3、简洁：言简意赅             =============

例如：比起 theNameOfUser ，显然 username更加方便，言简意赅

（1.2）包名：使用小写字母，不要使用间隔符号，不要使用大写字母

正确示例:  com.wang.bookshop

错误示例：com.wang.bookShop  、  com.wang.book_shop

（1.3）类名：首字母大写，明确后缀，规范分层

正确示例：MyShopService、MyShopDao、MyShop

错误示例：myShop、my_shop、MyShop1

（1.4）方法名：首字母小写，明确前缀，表达作用

正确示例：addUser()、removeUser()、updateUser()

错误示例：user()、myUser()

（1.5）域名

=============         1.5.1、 枚举、静态常量：大写锁定，下划线分割            =============

例如：QUERY_SUCCEED、QUERY_FAILED

=============          1.5.2、其他：首字母小写，驼峰法则              =============

例如:  bookName、bookType

2、代码格式

2.1、源文件编码：utf-8，结尾使用unix风格，使用"\n"作为换行符

1.Windows 中的换行符"\r\n"
2.Unix/Linux 平台换行符是 "\n"。
3.MessageBox.Show() 的换行符为 "\n"
4.Console 的换行符为 "\n"

2.2、行宽：不超过80

2.3、包的导入：删除不用的导入，尽量不使用整个包的导入

2.4、类格式

2.5、域格式

每行只声明一个域，域的声明用空行隔开。

2.6、方法格式

2.7、代码块

2.7.1、缩进风格

2.7.2、空格分隔：二元运算符前后、不换行的逗号后面

2.7.3、空行分隔：

        （1）连续两行的空行代表更大的语义分割；
        （2）方法之间用空行分割；
        （3）域之间用空行分割；
        （4）超过十行的代码如果还不用空行分割，就会增加阅读困难；

3、注释：表明类、域和方法等的意义和用法等的注释，要以javadoc的方式来写。

/**

*        类注释、域注释

**/



/*        方法注释        */



/------ start: ------/
块级注释
/-------- end: -------/



//TODO：更新订单信息

4、备注

减少嵌套层数（最好不超过3层）。

安装插件：Alibaba Java Coding Guidelines，检查代码规范。