代码规范及准备
代码规范
1 命名风格
-
代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / _name / $Object / name / name$ / Object$ -
标识符的命名要清晰、明了，有明确含义，使用完整的单词或者或者基本可以让大家理解的缩写，避免产生误解。
说明：较短的单词可以通过去掉“原因”形成缩写；较长的单词可以取单词的头几个字母形成缩写。 -
类名使用UpperCamelCase风格，必须遵从驼峰形式。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion -
方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId -
变量命名禁止使用单个字符你（如i、j、k），但i、j、k作为局部循环变量是允许的。
正例：MAX_STOCK_COUNT
反例：MAX_COUNT -
常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
-
抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
-
中括号是数组类型的一部分，数组定义如下：String[] args;
反例：使用String args[]的方式来定义。 -
包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
-
不允许未经定义的常量直接出现在代码中。
反例：String key = "Id#taobao_" + tradeId;
cache.put(key, value);
2 代码格式
-
大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
1） 左大括号前不换行。
2） 左大括号后换行。
3） 右大括号前换行。
4） 右大括号后还有 else 等代码则不换行；
5） 表示终止的右大括号后必须换行。 -
左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
-
if/for/while/switch/do 等保留字与括号之间都必须加空格。
-
任何二目、三目运算符的左右两边都需要加一个空格。 说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
-
采用 4 个空格缩进，禁止使用 tab 字符。
说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。 -
单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2） 运算符与下文一起换行。
3） 方法调用的点符号与下文一起换行。
4） 方法调用时，多个参数，需要换行时，在逗号后进行。
5） 在括号前不要换行，见反例。 -
方法参数在定义和传入时，多个参数逗号后边必须加空格。 正例：下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c"); . 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程 序将继续执行到哪一个 case 为止；
3 控制语句
-
在一个 switch 块内，都必须包含一个 default 语句并且 放在最后，即使它什么代码也没有。
-
在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用 单行的编码方式：if (condition) statements;
4 注释规约
-
方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释 使用/* */注释，注意与代码对齐。
-
所有的枚举类型字段必须要有注释，说明每个数据项的用途。
-
与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持 英文原文即可。
5 其他 -
在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。 说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);
-
不要在视图模板中加入任何复杂的逻辑。 说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。
-
任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
十天计划
| 天数 | 计划 |
|---|---|
| DAY1 | 学习相关知识,建立数据库，指定代码规范 |
| DAY2 | 后端搭建框架，建立和数据库的连接以及实体类，前端开始对部分界面的编写 |
| DAY3 | 后端完善业务逻辑实现部分和前端的接口，前端继续对界面的编写 |
| DAY4-8 | 后端：完成所需要的接口，和前端对接。前端：完善并美化页面。 |
| DAY9-10 | 修复以发现的BUG |
浙公网安备 33010602011771号