Java编码指南(3)

 

3          书写格式规范

【JAVA-1】       不使用Tab,而是使用4个空格代替一个Tab【规定】

说明·原因

如果缩进时同时使用了空白字符和Tab,会因编辑器的设定的不同而对不齐缩进,进而降低代码的可读性。请不要使用Tab,而是使用4个空格代替一个Tab。如果觉得输入一个一个空格字符很麻烦的话,可以使用编辑器的替换功能,在最后一齐转换。

 

【JAVA-2】       避免过长的行【推荐】

说明·原因

原则上,1行代码要控制在80字符左右。不仅是因为在显示器上看着费劲,在发送邮件或打印时也会非常难看,而且格式也会乱。

 

【JAVA-3】       "{"之后不写Statement【规定】

说明·原因

在"{"之后是不允许写Statement的。因为可读性会下降。因此无论多短的Statement,也请换行。

private void badSampleMethod(){int i = 0; // 错误

private void fixedSampleMethod(){

int i = 0; // 正确

 

【JAVA-4】       在逗号之后输入空白字符【规定】

说明·原因

在逗号之后请输入空白字符。这将提高代码的可读性。

 

【JAVA-5】       在赋值运算符(=、+=、-=、 …)前后输入空白字符【规定】

说明·原因

请在赋值运算符的前后输入空白字符。这将提高代码的可读性。

 

【JAVA-6】       for语句内的分号之后输入空白字符【规定】

说明·原因

请在赋值运算符的前后输入空白字符。这将提高代码的可读性。

for (int i = 0;i < 1000;i++){ // 错误

for (int i = 0; i < 1000; i++){ // 正确

 

【JAVA-7】       在“++”及“--”和运算数之间不输入空白字符【规定】

说明·原因

在前置单项运算符或后置运算符的“++”、“ --”和运算数(成为运算对象的值或变量)之间,不允许输入空白字符。会发生与其他运算混淆等不易分辨的问题。

System.out.println(“value :” + ++ a); // 错误

System.out.println(“value :” + ++a); // 正确

 

【JAVA-8】       在Bit运算符(“|”、“&”、“^”、“<<”、“>>”)的前后输入空白字符【规定】

说明·原因

请在Bit运算符的前后输入空白字符。这将提高代码的可读性。

 

【JAVA-9】       在逻辑运算符(“||”、“&&”)的前后输入空白字符【规定】

说明·原因

请在逻辑运算符的前后输入空白字符。这将提高代码的可读性。

 

【JAVA-10】   在关系运算符(“<”、“>”、“>=”、“<=”、“==”、“!= ”)的前后输入空白字符【规定】

说明·原因

请在关系运算符的前后输入空白字符。这将提高代码的可读性。

 

【JAVA-11】   在算术运算符(“+”、“-”、“*”、“/”、“%”)的前后输入空白字符【规定】

说明·原因

请在算术运算符的前后输入空白字符。这将提高代码的可读性。

 

【JAVA-12】   在条件运算符“?”的前后分别输入1个空白字符【规定】

说明·原因

所有的开发人员都按照相同的书写格式风格来编码,将提高代码的可读性。

int j = (i < 0)? 0 : i;  // 错误

int j = (i < 0) ? 0 : i;  // 正确

 

【JAVA-13】   最后写main()【推荐】

说明·原因

通过此规则,可遵照各种各样的编码标准来定义程序内的类。

class PML {
     public static void main (String args[]) {  // 错误
         System.out.println("Hello, world.");
     }
     void foo () {
     }
 }
class PMLFixed {
     void foo () {
     }
     public static void main (String args[]) {  // 正确
         System.out.println("Hello, world.");
     }
 }

 

【JAVA-14】   禁止使用System.out.println输出【推荐】

说明·原因

为了控制系统中的日志输出,原则上禁止使用System.out.println输出。调试阶段的System.out.println输出在发布时应该注释掉。

 

【JAVA-15】   避免长的布尔表达式,应换成多个更容易理解的表达式【推荐】

if ((elementNo < 0) || (elementNo > maxElement)|| elementNo == lastElement) {
     … 
}// 错误
 
bool isFinished = (elementNo < 0) || (elementNo > maxElement);
bool isRepeatedEntry = elementNo == lastElement;
if (isFinished || isRepeatedEntry) {
    … 
}// 正确

你可能感兴趣的:(Java)