阿里巴巴Java开发手册(第2版)-第1章(3)

简介: 本章是传统意义上的代码规范,包括变量命名、代码风格、控制语句、代码注释、前后端规约等基本的编程习惯,以及从高并发场景中提炼出来的集合处理技巧与并发多线程的注意事项。

1.3 代码格式

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";

      // 运算符的左右必须有1 个空格

      int flag = 0;

      // if 与括号之间必须有1 个空格

      // 括号内的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

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

正例:

double first = 3.14d;

int second = (int)first + 2;

8

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

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

缩进,参考示例;

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

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

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

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

正例:

StringBuilder sb = new StringBuilder();

// 在超过120 个字符的情况下,换行缩进4 个空格

// 方法前的点号一起换行

sb.append("yu").append("wen")...

      .append("han")...

      .append("han")...

      .append("han");

反例:

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 four = new StringBuilder();

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

13

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

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

目录
打赏
0
0
0
0
28
分享
相关文章
|
4月前
|
如何使用Java开发抖音API接口?
在数字化时代,社交媒体平台如抖音成为生活的重要部分。本文详细介绍了如何用Java开发抖音API接口,从创建开发者账号、申请API权限、准备开发环境,到编写代码、测试运行及注意事项,全面覆盖了整个开发流程。
621 10
一天成为Java开发高手:用飞算JavaAI实现十倍提效
“一天成为Java开发高手”曾被视为天方夜谭,但飞算JavaAI的出现改变了这一局面。这款AI开发助手通过智能引导、需求分析、自动化逻辑处理和完整代码工程生成,大幅简化了Java开发流程。它不仅帮助新手快速上手,还让资深开发者提高效率,减少调试时间。现在,参与“飞算JavaAI炫技赛”,展示你的开发实力,赢取丰厚奖品!
如何使用Java语言快速开发一套智慧工地系统
使用Java开发智慧工地系统,采用Spring Cloud微服务架构和前后端分离设计,结合MySQL、MongoDB数据库及RESTful API,集成人脸识别、视频监控、设备与环境监测等功能模块,运用Spark/Flink处理大数据,ECharts/AntV G2实现数据可视化,确保系统安全与性能,采用敏捷开发模式,提供详尽文档与用户培训,支持云部署与容器化管理,快速构建高效、灵活的智慧工地解决方案。
智慧产科一体化管理平台源码,基于Java,Vue,ElementUI技术开发,二开快捷
智慧产科一体化管理平台覆盖从备孕到产后42天的全流程管理,构建科室协同、医患沟通及智能设备互联平台。通过移动端扫码建卡、自助报道、智能采集数据等手段优化就诊流程,提升孕妇就诊体验,并实现高危孕产妇五色管理和孕妇学校三位一体化管理,全面提升妇幼健康宣教质量。
44 12
Java高级应用开发:基于AI的微服务架构优化与性能调优
在现代企业级应用开发中,微服务架构虽带来灵活性和可扩展性,但也增加了系统复杂性和性能瓶颈。本文探讨如何利用AI技术,特别是像DeepSeek这样的智能工具,优化Java微服务架构。AI通过智能分析系统运行数据,自动识别并解决性能瓶颈,优化服务拆分、通信方式及资源管理,实现高效性能调优,助力开发者设计更合理的微服务架构,迎接未来智能化开发的新时代。
菜鸟之路day02-04拼图小游戏开发一一JAVA基础综合项目
本项目基于黑马程序员教程,涵盖面向对象进阶、继承、多态等知识,历时约24小时完成。项目去除了登录和注册模块,专注于单机游戏体验。使用Git进行版本管理,代码托管于Gitee。项目包含窗体搭建、事件监听、图片加载与打乱、交互逻辑实现、菜单功能及美化界面等内容。通过此项目,巩固了Java基础并提升了实际开发能力。 仓库地址:[https://gitee.com/zhang-tenglan/puzzlegame.git](https://gitee.com/zhang-tenglan/puzzlegame.git)
46 6
【潜意识Java】javaee中的SpringBoot在Java 开发中的应用与详细分析
本文介绍了 Spring Boot 的核心概念和使用场景,并通过一个实战项目演示了如何构建一个简单的 RESTful API。
47 5
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
70 2

热门文章

最新文章