java开发手册-编程规约-代码格式

1.【强制】如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非空代码块则:

    1)左大括号前不换行。

    2)左大括号后换行。

    3)右大括号前换行。

    4)右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。

2.【强制】左小括号和右边相邻字符之间不出现空格;右小括号和左边相邻字符之间也不出现空格;而左大括号前需要加空格。详见第5条下方正例提示。

    反例:if (空格a == b空格)

3.【强制】if/for/while/switch/do等保留字与括号之间都必须加空格。

4.【强制】任何二目、三目运算符的左右两边都需要加一个空格。

    说明:包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5.【强制】采用4个空格缩进,禁止使用tab字符。

    说明:如果使用tab缩进,必须设置1个tab为4个空格。IDEA设置tab为4个空格时,请勿勾选Use tab character;而在eclipse中,必须勾选insert spaces for tabs。
    正例: (涉及1-5点)

public static void main(String[] args) {
    // 缩进4个空格
    String say = "hello";
    // 运算符的左右必须有一个空格
    int flag = 0;
    // 关键词if与括号之间必须有一个空格,括号内的f与左括号,0与右括号不需要空格
    if (flag == 0) {
        System.out.println(say);
    }
    // 左大括号前加空格且不换行;左大括号后换行
    if (flag == 1) {
        System.out.println("world");
    // 右大括号前换行,右大括号后有else,不用换行
    } else {
        System.out.println("ok");
    // 在右大括号后直接结束,则必须换行
    }
}

6.【强制】注释的双斜线与注释内容之间有且仅有一个空格。

    正例:

// 这是示例注释,请注意在双斜线之后有一个空格
String commentString = new String();

7.【强制】在进行类型强制转换时,右括号与强制转换值之间不需要任何空格隔开。

    正例:

long first = 1000000000000L;
int second = (int)first + 2;

8.【强制】单行字符数限制不超过120个,超出需要换行,换行时遵循如下原则:

    1)第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进,参考示例。

    2)运算符与下文一起换行。

    3)方法调用的点符号与下文一起换行。

    4)方法调用中的多个参数需要换行时,在逗号后进行。

    5)在括号前不要换行,见反例

    正例:

StringBuilder sb = new StringBuilder();
// 超过120个字符的情况下,换行缩进4个空格,并且方法前的点号一起换行
sb.append("zi").append("xin")...
    .append("huang")...
    .append("huang")...
    .append("huang");

    反例:

StringBuilder sb = new StringBuilder();
// 超过120个字符的情况下,不要在括号前换行
sb.append("you").append("are")...append
        ("lucky");
// 参数很多的方法调用可能超过120个字符,逗号后才是换行处
method(args1, args2, args3, ...
        , argsX);

9.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。

    正例:下例中实参的args1,后边必须要有一个空格。

method(args1, args2, args3);

10.【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式,不要使用Windows格式。

11.【推荐】单个方法的总行数不超过80行。

    说明:除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80行。

    正例:代码逻辑分清红花和绿叶,个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护。

12.【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。

    正例:

int one = 1;
long two = 2L;
float three = 3F;
StringBuilder sb = new StringBuilder();

    说明:增加sb这个变量,如果需要对齐,则给one、two、three都要增加几个空格,在变量比较多的情况下,是非常累赘的事情。

13.【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

    说明:任何情形,没有必要插入多个空行进行隔开。

本文参考于《java开发手册》

版权声明:参考文章后编写,版权归站长和原作者所有,转载请标明出处
转载请注明:https://blog.grstudy.com/programming/note/69
免责声明&联系方式
作者头像
boss创始人

站长

上一篇:java开发手册-编程规约-常量定义
下一篇: java开发手册-编程规约-OOP规约