Commit 0357db98 authored by yang's avatar yang

modify codeStyle.md

parent d934bfd4
...@@ -7,7 +7,6 @@ ...@@ -7,7 +7,6 @@
4. 原则上不允许使用递归,部分情况可以使用尾递归。 4. 原则上不允许使用递归,部分情况可以使用尾递归。
5. 代码中不允许出现魔法值,即未定义的任何常量。 错误的用法不限于以下形式: 5. 代码中不允许出现魔法值,即未定义的任何常量。 错误的用法不限于以下形式:
```java ```java
if(user.getStatus() == 5){ if(user.getStatus() == 5){
// 5即为魔法值,应当避免使用 // 5即为魔法值,应当避免使用
// do something // do something
...@@ -16,7 +15,6 @@ if(user.getStatus() == 5){ ...@@ -16,7 +15,6 @@ if(user.getStatus() == 5){
6. 在类中定义的常量、变量及方法,需要严格控制访问修饰符,提供自己使用的设为private,可以供别人使用的可以设为public、protected等。 6. 在类中定义的常量、变量及方法,需要严格控制访问修饰符,提供自己使用的设为private,可以供别人使用的可以设为public、protected等。
7. 所有的覆写方法,必须加@Override注解,防止错误的拼写导致意外。 7. 所有的覆写方法,必须加@Override注解,防止错误的拼写导致意外。
--- --- --- ---
--- ---
## 二、命名规范 ## 二、命名规范
1. 所有的命名不允许使用**拼音或者拼音英文混合**方式,但部分公认的拼音允许使用,如**shanghai,beijing**等。 1. 所有的命名不允许使用**拼音或者拼音英文混合**方式,但部分公认的拼音允许使用,如**shanghai,beijing**等。
2. 所有的命名不允许使用**下划线_**或者**美元符$**作为起始或者结束。错误的情况有不限于以下几种: 2. 所有的命名不允许使用**下划线_**或者**美元符$**作为起始或者结束。错误的情况有不限于以下几种:
...@@ -25,6 +23,7 @@ if(user.getStatus() == 5){ ...@@ -25,6 +23,7 @@ if(user.getStatus() == 5){
* **param_** * **param_**
* **param$** * **param$**
* **_param$** * **_param$**
### 包命名规范 ### 包命名规范
1. 包名一般为域名倒叙开头,后接项目名,再加上单数形式的名词(项目中一般使用模块代码),且全部为小写字母,如: 1. 包名一般为域名倒叙开头,后接项目名,再加上单数形式的名词(项目中一般使用模块代码),且全部为小写字母,如:
* 系统功能模块:**com.hand.hls.sys** * 系统功能模块:**com.hand.hls.sys**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment