Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
H
hel-developer-guide
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
chenhao
hel-developer-guide
Commits
68a5921e
Commit
68a5921e
authored
Jul 31, 2017
by
yang
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
modify codeStyle.md
parent
70630432
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
10 deletions
+15
-10
codeStyle.md
codeStyle.md
+15
-10
No files found.
codeStyle.md
View file @
68a5921e
## 一、
项目开发规范
## 一、
后端开发规范[](#backEndDev)
1.
所有的项目文件必须采用UTF-8编码,IDEA及Eclipse需要手动设置项目编码以及编译编码。
1.
所有的项目文件必须采用UTF-8编码,IDEA及Eclipse需要手动设置项目编码以及编译编码。
-
Eclipse中修改项目编码的方法参考:
[
Eclipse修改编码方法
](
http://jingyan.baidu.com/article/647f0115b0c9887f2148a822.html
)
-
Eclipse中修改项目编码的方法参考:
[
Eclipse修改编码方法
](
http://jingyan.baidu.com/article/647f0115b0c9887f2148a822.html
)
-
IDEA中修改项目编码的方法参考:
[
IDEA修改编码方法
](
http://jingyan.baidu.com/article/948f5924e4de57d80ff5f998.html]
)
-
IDEA中修改项目编码的方法参考:
[
IDEA修改编码方法
](
http://jingyan.baidu.com/article/948f5924e4de57d80ff5f998.html]
)
...
@@ -30,16 +30,15 @@ if(user.getStatus() == EXPIRED_USER_STATUS){
...
@@ -30,16 +30,15 @@ if(user.getStatus() == EXPIRED_USER_STATUS){
12.
部分异常若是上层(调用层)不能解决,则不允许抛出。最外层若是出现异常必须自行处理,不可将异常信息直接展示给用户。
12.
部分异常若是上层(调用层)不能解决,则不允许抛出。最外层若是出现异常必须自行处理,不可将异常信息直接展示给用户。
13.
所有的日志信息
**不允许使用System.out.println**
输出,异常的日志信息使用
**log.error**
打印时,必须使用重载方法将捕获的异常作为第二个参数。如:
13.
所有的日志信息
**不允许使用System.out.println**
输出,异常的日志信息使用
**log.error**
打印时,必须使用重载方法将捕获的异常作为第二个参数。如:
```
java
```
java
try
{
try
{
// throw some exceptions
// throw some exceptions
}
catch
(
IOException
e
){
}
catch
(
IOException
e
){
logger
.
error
(
e
.
getMessage
(),
e
);
logger
.
error
(
e
.
getMessage
(),
e
);
}
}
```
```
--- ---
--- ---
## 二、后端命名规范[](#backEndName)
## 二、命名规范
1.
所有的命名不允许使用
**拼音或者拼音英文混合**
方式,但部分公认的拼音允许使用,如
**shanghai,beijing**
等。
1.
所有的命名不允许使用
**拼音或者拼音英文混合**
方式,但部分公认的拼音允许使用,如
**shanghai,beijing**
等。
2.
所有的命名不允许使用
**下划线`_`**
或者
**美元符`$`**
作为起始或者结束。错误的情况有不限于以下几种:
2.
所有的命名不允许使用
**下划线`_`**
或者
**美元符`$`**
作为起始或者结束。错误的情况有不限于以下几种:
-
**_param**
-
**_param**
...
@@ -130,3 +129,9 @@ try{
...
@@ -130,3 +129,9 @@ try{
5.
对数据库进行数据更新的方法,一般以
**update**
开头,后接插入的对象,若是允许批量插入对象,对象名可变为复数,如:
5.
对数据库进行数据更新的方法,一般以
**update**
开头,后接插入的对象,若是允许批量插入对象,对象名可变为复数,如:
-
`public SysRole updateSysRole(SysRole role)`
-
`public SysRole updateSysRole(SysRole role)`
-
`public int updateSysUsers(List<SysUser> users)`
-
`public int updateSysUsers(List<SysUser> users)`
--- ---
## 三、前端开发规范[](#frontEndDev)
--- ---
## 四、前端命名规范[](#frontEndName)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment