代码格式


其它相关文章
Java 编码规范1(编程规约-命名风格)
Java 编码规范2(编程规约-常量定义)
Java 编码规范3(编程规约-代码格式)
Java 编码规范4(编程规约-OOP规约)
Java 编码规范5(编程规约-集合处理)
Java 编码规范6(编程规约-并发处理)
Java 编码规范7(编程规约-控制语句)
Java 编码规范8(编程规约-注释规约与其它)
Java 编码规范9(异常日志)
Java 编码规范10(单元测试)
Java 编码规范11(安全规约)
Java 编码规范12(MySQL-建表规约)
Java 编码规范13(MySQL-索引规约)
Java 编码规范14(MySQL-SQL语句与ORM映射)
Java 编码规范15(工程结构)


  1. [强制] 大括号的使用约定。

    • 如果是大括号内为空,则简洁地写成{}即可,不需要换行;
    • 如果是非空代码块则:
      • 左大括号前不换行。//==其它的都是异端,通通乱棍拖出去。==
      • 左大括号后换行。
      • 右大括号前换行。
      • 右大括号后还有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-6点)

      // 请注意所有注释,在双斜线之后有一个空格
      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. [强制] 注释的双斜线与内容之间有且仅一个空格。

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

    • 第二行相对一缩进 4个空格,从第三行开始不再继续缩进参考示例。
    • 运算符与下文一起换行。
    • 方法调用的点符号与下文一起换行。
    • 方法调用时,多个参数,需要换行时,在逗号后进行。
    • 在括号前不要换行,见反例。
    • 正例:

      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);
  8. [强制] 方法参数在定义和传入时,多个参数逗号后边必须加空格。

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

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

  9. [强制] IDE的text file encoding设置为UTF-8; IDE中,文件的换行符使用Unix格式,不要使用Windows格式。
  10. [推荐] 没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。

    • 正例:

      int a = 3;
      long b = 4L;
      float c = 5F;
      StringBuffer sb = new StringBuffer();
  11. [推荐] 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

    • 没有必要插入多个空行进行隔开。

Java 编码规范3(编程规约-代码格式)相关推荐

  1. Java 编码规范1(编程规约-命名风格)

    编程规约-命名风格 其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-O ...

  2. Google 出品的 Java 编码规范和编程指南!

    这份文档是Google Java编程风格规范的完整定义.当且仅当一个Java源文件符合此文档中的规则, 我们才认为它符合Google的Java编程风格. 与其它的编程风格指南一样,这里所讨论的不仅仅是 ...

  3. Java 编码规范15(工程结构)

    工程结构 其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-OOP规约) ...

  4. Java编码规范V1.0

     Java编码规范V1.0 1 代码总体原则 1. 清晰第一 清晰性是易于维护.易于重构的程序必需具备的特征.代码首先 是给人读的,其次才给机器用来执行. 目前软件维护期成本占整个生命周期成本的 40 ...

  5. 阿里巴巴对Java编程【代码格式】的规约

    转载自 阿里巴巴对Java编程[代码格式]的规约 代码格式 1. [强制]大括号的使用约定.如果是大括号内为空,则简洁地写成{}即可,不需要换行 : 如果是非空代码块则: 1 ) 左大括号前不换行. ...

  6. 公司让我编写一套自己的【Java 编码规范】作为员工季度考核标准?!参照Alibaba

    目录 一.编码规范 (一)命名风格 (二)常量定义 (三)代码格式 (四)OOP规范 (五)集合处理 (六)并发处理 (七)控制语句 (八)注释规范 (九)其它 二.SVN操作规范 三.异常日志 (一 ...

  7. java编码ppt_[2018年最新整理]Java编码规范.ppt

    [2018年最新整理]Java编码规范 制定编码规范的最主要的目的是为了对产出代码的长期维护.通常负责 维护代码的人大多都不是开发者本人,如果有一个统一的代码格式以及 说明就可以减少混淆提高理解速度. ...

  8. java编码规范文档 下载_软件项目实训及课程设计指导——制定待开发项目中各种文档的规范...

    软件项目实训及课程设计指导--制定待开发项目中各种形式文档的规范 1.制定对课程设计项目开发过程中的规范性要求 (1)从"形式"到"内容"两个方面控制和要求开发 ...

  9. 阿里Java开发手册之编程规约

    阿里Java开发手册之编程规约 对于程序员来说,编程规范可以养成良好的编程习惯,提高代码质量,降低沟通成本.就在2月9号,阿里出了一份Java开发手册(正式版),分为编程规约,异常日志,MySQL规约 ...

  10. Java编码规范相关-开发手册-IDEA插件-P3C-sonarLint-代码格式化

    编码规范 一.大厂的规范手册 1.阿里巴巴<Java开发手册(嵩山版)> 广为流传的手册,我基本每个开发机都会放一本,用来做参考,想起来就看一下,反思自己之前的瑕疵,完善和修正自己的编码习 ...

最新文章

  1. 自动驾驶汽车事故的责任追究
  2. 浙江将建设超级高速公路,全面支持自动驾驶
  3. 深度优先算法回溯实例
  4. c#一种存储结构解决动态平衡问题
  5. 数据结构与算法 —— 二叉树
  6. uvalive4835(模拟)
  7. [LeetCode] Count Numbers with Unique Digits 计算各位不相同的数字个数
  8. MySQL与Oracle主键冲突解决方式
  9. CopyTranslator v0.0.8 Zouwu RC1 发布
  10. extract-text-webpack-plugin
  11. 用计算机字符写名字,NSIS:把计算机名转换为大写或小写字符
  12. [总结] Min-Max容斥学习笔记
  13. 浅析JSONP-解决Ajax跨域访问问题
  14. 集合操作retainAll和removeAll
  15. ArcGIS API For JavaScript 利用GP服务生成等值线、等值面(一)之生成等值线
  16. 怒肝半月!Python 学习路线+资源大汇总
  17. 查看twitter浏览记录_您可以看到谁查看了您的Twitter个人资料吗?
  18. cufflinks 绘图
  19. android七牛多张图片上传
  20. 写一封信给N年前的自己

热门文章

  1. 高效办公软件推荐——文件搜索类
  2. jfinal 和bjui 常用前后交互方式
  3. 电商大数据分析案例(Hadoop+Hive+Spark+Azkaban+Spring MVC+ECharts)
  4. wps表格在拟合曲线找点_excel如何拟合曲线方程
  5. 用javaScript实现轮播图效果 包括自动变换,按钮控制,上一张下一张切换
  6. OpenCV算法精解1--OpenCV中C++基本操作1
  7. C语言员工信息管理系统源代码
  8. Rational Rose下载安装教程
  9. 原生js添加class
  10. CE修改器入门:查找共享代码