Java教程

代码格式(参照阿里Java开发手册)

本文主要是介绍代码格式(参照阿里Java开发手册),对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!

(阿里巴巴 Java开发手册 )

1、大括号的使用约定

如果大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块,则:

1、左大括号前不换行

2、左大括号后换行

3、右大括号前换行

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

2、小括号使用

左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格。

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 == 1) {
        System.out.println(say);
    }
    // 左大括号前不换行,左大括号后换行
    if (flag == 1) {
        System.out.println("world");
    // 右大括号前换行,右大括号后还有else等代码则不换行
    } else {
        System.out.println("ok");
    // 表示终止的右大括号后必须换行 
    }
}

6、注释的双斜线与注释内容之间有且仅有一个空格

7、单行字符数限制不超过120个,超出需要换行,换行须遵循如下原则

1、第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进;

2、运算符与下文一起换行;

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

4、方法调用时,多个参数,需要换行时,在逗号后进行;

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

‘正例’

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

‘反例’

// 反例,不要在括号前换行
StringBuffer sd = new StringBuffer();
sd.append("zi").append("xin")...append
    ("xin");
// 不要在逗号前换行
method(args1, args2, ...
        , argsX);

8、方法参数在定义和传入时,多个参数逗号后边必须加空格

‘’method("a", "b", "c");

9、IDE格式

IDE的 text file encoding 设置为 UTF-8;IDE中文件的换行符使用Unix格式,不要使用windows格式

10、没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐

11、空行

不同逻辑、不同语义、不同业务的代码之间插入一个空行分割开来以提升可读性

说明:没有必要插入多个空行进行隔开。

这篇关于代码格式(参照阿里Java开发手册)的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!