阿里规约代码格式

  1. 【强制】大括号的使用约定。
    如果是大括号内为空,则简洁地写成{}即可,不需要换行;
    如果是非空代码块则:  1) 左大括号前不换行。  
                    2) 左大括号后换行。  
                    3) 右大括号前换行。  
                    4) 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。
    理解:这也算是大括号的常规用法。
    
  2. 【强制】 左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格。
    反例:if ( a == b ) 
    理解: 小括号的使用标准规约。
    
  3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
    理解: 这个规定好。
    
  4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。
    说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
    理解:min = (a<b) ? a : b;   这里的? : 需要三个操作对象,称为三目运算符
    
  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");     
              // 在右大括号后直接结束,则必须换行      
           }  
      } 
    理解:这个也算规约吧。和1、2、3、4一样都可以设定在IDEA或者Eclipse配置文件中。
    
  6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
    正例:// 注释内容,注意在//和注释内容之间有一个空格
    理解:规约。
    
  7. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:
    1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
    2) 运算符与下文一起换行。
    3) 方法调用的点符号与下文一起换行。
    4) 方法调用时,多个参数,需要换行时,在逗号后进行。
    5) 在括号前不要换行,见反例。
    正例: 
    StringBuffer sb = new StringBuffer();  
    // 超过 120 个字符的情况下,换行缩进 4 个空格,点号和方法名称一起换行  sb.append("zi").append("xin")...    
     .append("huang")...  
     .append("huang")...  
     .append("huang");  
    反例: StringBuffer sb = new StringBuffer();  
    // 超过 120 个字符的情况下,不要在括号前换行  
    sb.append("zi").append("xin")...append      
     ("huang");   
    // 参数很多的方法调用可能超过 120 个字符,不要在逗号前换行  
    method(args1, args2, args3, ...      
     , argsX);
    理解:这个很实用,StringBuffer(线程安全的),StringBuilder(非线程安全的)拼接字符串(如:sql语句),方法参数多,参数名称长时都会用到。
    
  8. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。
    正例:下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c");
    理解:方法或过程在定义或调用时,参数之间用逗号加空格隔开。
    
  9. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式, 不要使用 Windows 格式
    理解:在各操作系统下,文本文件所使用的换行符是不一样的。UNIX/Linux 使用的是 0x0A(LF)('\n' 换行),早期的 Mac OS 使用的是0x0D(CR)('\r'回车),后来的 OS X 在更换内核后与 UNIX 保持一致了。但 DOS/Windows 一直使用 0x0D0A(CRLF)('\r\n'回车换行)作为换行符。为了避免出现混乱,遵循这种规定。
    
  10. 【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
    正例:   int a = 3;  
            long b = 4L;  
            float c = 5F;  
            StringBuffer sb = new StringBuffer();  
    说明:增加 sb 这个变量,如果需要对齐,则给 a、b、c 都要增加几个空格,在变量比较多的情况下,是一种累赘的事情。
    理解:没有必要的累赘操作可以休矣。
    
  11. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
    说明:没有必要插入多个空行进行隔开。
    理解:是否要加空行,或多或少会有滥用。
    
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容