小贴士编码tips
目录结构
编码规格篇
项目构成篇
java基础篇
java表演篇
java线程篇
java设计篇
代码审查篇
数据库篇
模板篇
开发运输篇
数据库设计命名约定篇
其他篇
编码规格篇
3
命名约定
命名包
软件包名称全部小写，软件包路径符合所开发的系统模块的定义，并使用尽可能单一的责任原则
所有纯真乌龟的包路径都被命名为com.wuage.xx。 (其中xx是具体的业务关联) )。
例如：
com.wuage.seller
com.wuage.crm
com.wuage.order
类名
类名的首字母必须大写。 所有标识符(如全局变量、方法、参数和局部变量)的首字母必须小写，并且必须使用驼峰匹配法。 命名以满足名意
4
命名约定
接口
用完整的英语描述符说明接口封装，并将所有单词的第一个字符大写。 习惯上，姓名前加大写I，遵守单一职责原则和界面隔离原则
例如：
接口I raster
方法
方法采用完整的英语讲解说明成员方法的功能，第一个单词尽量使用生动的动词，尽量满足有名的意义，注意使用设计原则
例如：
sayHello () ) )。
getName () )
run () ) )
5
命名约定
常数字段
一般都采用大写字母，用下划线分隔单词之间。 (在某些特例中，Java类库的颜色常量不严格使用全部大写字符。 ）
例如：
static final int MIN_WIDTH
static final int MAX_WIDTH
变量字段
采用驼峰法，恪守见名识义原则
例如：
int myIndex
6
搭配句子
错误代码
if (condition )
语句1；
是if(condition1)
是if(condition2)
语句2；
else
语句3；
正确的代码
if(condition ) {
语句1；
}
if(condition1) {
if(condition2) {
语句2；
}
} else {
语句3；
}
7
DAO层命名约定
DAO接口都以I开始，以DAO结束。 例如IUserDAO.java
所有DAO实现类都以IBatis开始，以Impl结束，并继承DAO接口
例如，IBatisUserDAOImpl.java
所有实体都以Model结尾
例如，用户模型
8
服务设计规范
读写分离
接口
写入接口以I开始，以OperateService结束，如IUserOperateService.java
接口在以I开头的查询服务(如IUserQueryService.java )中结束
实现类
以OperateServiceImpl或QueryServiceImpl结尾。 例如，UserQueryServiceImpl.java
自我包容
尽量捕捉日常输出异常、弥补业务方面错误的代码
9
使用正确的代码格式
创建代码模板和代码格式文件
打开Eclipse并导入代码样式/代码格式. XML
10
Eclipse代码模板s
11
Eclipse代码模板s-auto add
12
Eclipse Save Actions
13
14
1、应用名称用_连接，两个子项目命名为。
例如，APP应用：被称为wuage_web中的子项目，并且可以被称为wuage_web.config
注意：
2、自动配置文件必须放入src/main/resource或war中
命名Java项目
java文件目录结构
使用标准maven结构，具体包待定
15
Java基础篇
16
规格说明
一行的长度不超过120个字符，且至少120个字符换行，操作符位于新行的开头； 新行必须至少缩进8个字符以上。
不允许把多个短句子写在一行上。 也就是说，一行只写一个句子。
if、for、do、while、case、switch、default等语句在一行中被占用，if、for、do、while等语句的执行语句部分多少带有括号{}。
请务必在相对独立的块间、变量的说明后插入空行
提供包含版权说明、版本号、创建日期、作者、模块目的、功能和更改日志等信息的文件注释。 文件的注释必须放在package之前。
说明：名称使用中文名称。
示例：
/*
*版权(c )、待办事宜
*
*/
类注释放在class或接口关键字之前
类评论放在class中