Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
W
wiki-java
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • Operations
    • Operations
    • Incidents
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • 老徐
  • wiki-java
  • Wiki
  • java code specification

java code specification · Changes

Page history
ulindows deleted page: JavaCodeSpecification authored Jun 13, 2016 by 老徐's avatar 老徐
Hide whitespace changes
Inline Side-by-side
Showing with 67 additions and 0 deletions
+67 -0
  • java-code-specification.md java-code-specification.md +67 -0
  • No files found.
java-code-specification.md
View page @ e8e55325
......@@ -486,18 +486,85 @@ if (0 != flag)
```
#### 8.2 循环语句
  for语句的标准写法是:
```
for (i = 0; i < n; i++)
{
expr2;
}
```
&emsp;&emsp;while语句的标准写法是:
```
while (expr)
{
....
}
```
&emsp;&emsp;do-while语句的标准写法是:
```
do
{
....
} while (expr);
```
&emsp;&emsp;为了保持结构紧凑,for后面的()内的内容可以省略空格。
&emsp;&emsp;循环语句的判断,遵循6.1的有关规则。
&emsp;&emsp;循环语句的内部禁止修改循环变量。
#### 8.3 switch语句
&emsp;&emsp;switch语句的标准写法如下:
```
switch (expr)
{
case const-expr1:
....
break;
case const-expr2:
....
break;
default:
....
break;
}
```
&emsp;&emsp;switch语句的每个分支都要加break,否则一定是用注释说明。switch语句的最后一定要使用default语句,即使只有default : break。这样防止别人以为你忘记了default处理。
### 9 方法
#### 9.1 避免方法参数过多
&emsp;&emsp;一个方法的参数建议不要超过5个。
#### 9.2 建议方法只有唯一的出口
#### 9.3 如果返回不是void,必须提供返回值
&emsp;&emsp;示例:
```
Integer function(Integer parameter)
{
if (null != parameter)
{
return parameter;
}
} //else的时候返回什么?
```
#### 9.4 重复使用的代码用方法替代
### 10 类
#### 10.1 提高类内的聚合度
&emsp;&emsp;高内聚指的是在进行类设计的时候强调专注于某一件事或者一个目标,并且把它做好。
&emsp;&emsp;如果数据成员超过10个,则这个类很有可能内聚性较差。
#### 10.2 降低类之间的耦合度
&emsp;&emsp;低耦合是减少类之间的依赖程度。
#### 10.3 努力使类的接口少而完备
&emsp;&emsp;一个完备的接口指使用者可以通过它(对类)作任何合理的事情。接口少,指的是类里面的方法尽可能的少。
&emsp;&esmp;一个类的成员方法不应该超过20个。
### 11 其它
#### 11.1 无论什么时候,为你的正式程序编写单元测试代码
&emsp;&emsp;即使你的方法非常简单,只有三五行,而且实现的功能非常简单,都尽可能为你的代码编写单元测试代码,对于功能复杂的核心代码,尽可能进行100%的单元测试。
#### 11.2 建立项目内部编码规范
&emsp;&emsp;本文是用于公司的JAVA编程规范,对编程的一些细节并没有规定到。比如在水滴项目组和数据平台组两个项目组内部使用的变量命名规范,文件名和目录命名原则就会有很大不同,需要项目组把自己内部的编程规范文档化。另外,本规范是以Java语言作为基础制定的,如果项目组使用到了其他的语言入Python,Php,Go也应该有相应的规范,并且把它们文档化。SEPG组会整理这些规范,作为公司的技术积累的财富。
#### 11.3 代码中使用到的算法或常量是根据某个规范而实现的,必须用注释说明
#### 11.4 禁止使用IDE的格式化功能格式化已有的代码
\ No newline at end of file
Clone repository
  • git configuration and simple use
  • Home
  • java code specification
  • maven environment configuration
  • shuidi js develope
  • ucs_project environment configuration