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)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • java path环境变量_java配置环境变量

    java path环境变量_java配置环境变量前段时间因为windows10更新的缘故,系统越来越卡,任务管理器也闪退,试了各种方法都不管用,反而越改问题越多,乘着周末,昨天把系统重装了,现在记录一下配置java环境变量的过程。1.安装jdk,从官网下就行,我的是把原来的做了个备份,直接解压的。如下图2.记录下你要配置的jdk路径。右键此电脑,属性,点击高级系统设置,选择环境变量。3.现在就可以新建环境变量了。点击新建,变量名为JAVA_HO…

    2022年5月31日
    22
  • 51单片机最小系统板制作过程

    51单片机最小系统板制作过程本文将介绍如何自制一个51单片机最小系统及一些附加模块。最终制成的系统将具有烧录程序,运行程序等功能。

    2022年6月23日
    33
  • wxpython-wxpython教程

    wxpython-wxpython教程wxPython是一个Python包装wxWidgets(这是用C++编写),一个流行的跨平台GUI工具包。由RobinDunn以及HarriPasanen开发,wxPython是作为一个Python扩展模块。就像wxWidgets,wxPython也是一个免费的软件。它可以从官方网站下载:http://wxpython.org.在本网站上可下载wxPython对应操作系统平台二进…

    2022年5月11日
    23
  • 作业2 分析TGA文件「建议收藏」

    一、TGA文件格式解析二、文件格式文件头(TgaFileHeader):由图像描述信息字段长度、颜色表类型、图像类型、颜色表说明和图像说明五个字段组成,总计18字节,描述了图像存储的基本信息,应用程序可依据该部分字段值读写图像数据。图像/颜色表数据(Image/ColorMapData):由图像描述信息(可选)、颜色表数据和图像数据三部分组成,用于存储图片的图像信息。开发者自定义区域(DeveloperArea):包含开发者定义字段列表和开发者字典(用于存储开发者定义字段的值),该区域为

    2022年4月9日
    41
  • NetworkManager 学习

    NetworkManager 学习传送门:http://wiki.friendlyarm.com/wiki/index.php/Use_NetworkManager_to_configure_network_settings/zh1什么是NetworkManagerNetworkManager是一个检测网络、自动连接网络的程序(网络管理器),无论是无线网络,还是有线连接,它都可以令您轻松管理。NetworkManager…

    2022年9月28日
    2
  • 《前端运维》二、Nginx–4代理、负载均衡与其他

    一、代理服务比较容易理解吧,简单来说。客户端访问服务器并不是直接访问的,而是通过中间代理服务器,代理服务器再去访问服务器。就像一个中转站一样,无论什么,只要从客户端到服务器,你就要通过我。一)正向

    2022年3月25日
    43

发表回复

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

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