文档介绍：文档编号
初稿
文档版本
Total 23 pages 共 23 页
Java语言编码规范
Prepared by
拟制
Date
日期
2016-07-15
Reviewed by
评审人
Date
日期
Approved by
批准
Date
日期
目录
1. 排版规范 3
. 规则 3
2. 注释规范 6
. 规则 6
. 建议 11
3. 命名规范 14
. 规则 14
. 建议 15
4. 编码规范 17
. 规则 17
5. 范例说明 21
排版规范
规则
*程序块要采用缩进风格编写,缩进的空格数为4个。
说明:对于由开发工具自动生成的代码可以有不一致。
*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:如下例子不符合规范。
for (...) {
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
应如下书写:
for (...)
{
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}
*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
示例:
if (filename != null
&& new File(logPath + filename).length() < ())
{
... // program code
}
public static LogIterator read(String logType, Date startTime, Date endTime,
int logLevel, String userName, int bufferNum)
*不允许把多个短语句写在一行中,即一行只写一条语句
示例:如下例子不符合规范。
LogFilename now = null; LogFilename that = null;
应如下书写:
LogFilename now = null;
LogFilename that = null;
*if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while等语句的执行语句无论多少都要加括号{}。
示例:如下例子不符合规范。
if(writeToFile) ();
应如下书写:
if (writeToFile)
{
();
}
*相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if (() < ())
{
return;
}
LogWriter writer;
应如下书写:
if (() < ())
{
return;
}
LogWriter writer;
int index;
*对齐只使用空格键,不使用TAB键。
说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。JBuilder、UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开。
*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。
说明:采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右