当前位置 主页 > 网站技术 > 代码类 > 最大化 缩小

    详解Java编程规约(命名风格、常量定义、代码格式)(3)

    栏目:代码类 时间:2019-11-11 06:01

    2、【强制】在 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。

    说明:Long a = 2l; 写的是数字的 21,还是 Long 型的 2。

    3、【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。

    说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护。

    正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下。

    4、【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、

    包内共享常量、类内共享常量。

    1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。

    2) 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。

    反例:易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了“YES”的变量:

    类 A 中:public static final String YES = "yes";

    类 B 中:public static final String YES = "y";

    A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致线上问题。

    3) 子工程内部共享常量:即在当前子工程的 constant 目录下。

    4) 包内共享常量:即在当前包下单独的 constant 目录下。

    5) 类内共享常量:直接在类内部 private static final 定义。

    5【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

    说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的

    第几个季节。

    正例:

    public enum SeasonEnum {
     
      SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
     
      private int seq; 
      SeasonEnum(int seq) {this.seq = seq;}
      public int getSeq() {return seq;}
     
    }
     
    
    

    代码格式

    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");
    
    // 在右大括号后直接结束,则必须换行 }
    
    }