Java开发手册之代码格式

Java开发手册之代码格式Java开发手册之代码格式

大家好,又见面了,我是你们的朋友全栈君。

  1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:
    1) 左大括号前不换行。
    2) 左大括号后换行。
    3) 右大括号前换行。
    4) 右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。
  2. 【强制】 左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格。详见第5条下方正例提示。
    空格 a == b 空格
    反例:if ()
  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");      
    // 在右大括号后直接结束,则必须换行      
    }  
    }  
  1. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
    正例:// 注释内容,注意在//和注释内容之间有一个空格。
  2. 【强制】单行字符数限制不超过 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);  
  1. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。
    正例:下例中实参的”a”,后边必须要有一个空格。
    method("a", "b", "c");  
  1. 【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式,不要使用Windows格式。
  2. 【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
    正例:
int a = 3;  
long b = 4L;  
float c = 5F;  
StringBuffer sb = new StringBuffer();  

说明:增加sb这个变量,如果需要对齐,则给a、b、c都要增加几个空格,在变量比较多的情况下,是一种累赘的事情。
12. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
说明:没有必要插入多个空行进行隔开。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/106540.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • kafka队列模式_redis消息队列和mq

    kafka队列模式_redis消息队列和mq一、消息队列概述消息队列中间件是分布式系统中重要的组件,主要解决应用解耦,异步消息,流量削锋等问题,实现高性能,高可用,可伸缩和最终一致性架构。目前使用较多的消息队列有ActiveMQ,RabbitMQ,ZeroMQ,Kafka,MetaMQ,RocketMQ二、消息队列应用场景以下介绍消息队列在实际应用中常用的使用场景。异步处理,应用解耦,流量削锋和消息通讯四个场景。2.1异步处理场景说明:用户注册后,需要发注册邮件和注册短信。传统的做法有两种1.串行的方式;2.并行方式a、串行方式:将注册

    2022年10月9日
    0
  • 华硕笔记本电脑怎么重装系统_华硕笔记本 重装系统

    华硕笔记本电脑怎么重装系统_华硕笔记本 重装系统原标题:超详细华硕笔记本电脑重装系统图文教程重装系统难吗?不难,难的是你不愿意尝试迈出第一步。今天给大家分享的是超详细华硕笔记本电脑重装系统图文教程,通过使用小白一键重装系统工具可以让我们快速的了解并使用在线重装系统方式来完成Windows10系统安装。小白一键重装系统在线重装Windows10系统步骤:1、百度搜索小白系统官网访问官网并下载小白一键重装系统软件打开。2、在选择系统列…

    2022年8月12日
    5
  • Swift如何给应用添加3D Touch菜单

    Swift如何给应用添加3D Touch菜单

    2021年5月27日
    146
  • p6spy mysql8_P6Spy配置使用

    p6spy mysql8_P6Spy配置使用P6Spy是一个可以用来在应用程序中拦截和修改数据操作语句的开源框架。通过P6Spy我们可以对SQL语句进行拦截,相当于一个SQL语句的记录器,这样我们可以用它来作相关的分析,比如性能分析。P6SPY提供了如下几个功能:记录SQL语句的执行时间戳。记录SQL语句类型记录SQL填入参数的和没有填入参数的SQL语句根据配置的时间控制SQL语句的执行时间,对超出时间的SQL语句输出到日志文件中下面是p…

    2022年10月6日
    0
  • 职场人为什么需要理财[通俗易懂]

    职场人为什么需要理财[通俗易懂]早理财比晚理财好,保持财产增值的同时,运气好赶上一波风口,比如股市牛市,黄金牛市等,就能比那些不理财的人更快完成原始资本积累。理好财能给我们带来更好的安全感和成就感,职场人士也多了一份睡后收入,何乐而

    2022年8月3日
    3
  • TinyXML2使用总结「建议收藏」

    TinyXML2使用总结「建议收藏」TinyXML2是简单实用的开源的C++XML文件解析库,可以很方便的应用到现有的项目之中。 TinyXML2解析器相对TinyXML1在代码上是完全重写,使其更适合于游戏开发中使用。它使用更少的内存,更快,并使用更少的内存分配。xml类似数据库,一般来说对数据库有什么操作,那么对xml文件也能实现什么操作。数据库增删查改对应xml文件就是新建xml文件…

    2022年5月11日
    29

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号