美国上市公司,专注Java培训21年

Java代码规范你知道多少,重要吗?


在进行Java代码敲写的时候,我们知道是有很多的Java代码规范是需要遵守的,但是有的Java学员就老是忘记,还有的Java学员是不屑遵守的,内心想着是只要我写Java代码OK,遵不遵守Java代码规范,有什么问题呢?其实是存在问题的,为什么要遵守Java代码规范?当你第一次接触到Java代码规范的时候,你是不是觉得很麻烦呢?比如关于统一的原则,一再的强调,但是你一再的忘记,或者压根就不想照做,会出现什么样的后果呢?今天达内教育IT培训的小编将借Java代码规范中的统一来说说,自己对为什么要遵守Java代码规范,发表自己简单的看法。

1.文件组织:程序行数不宜过多,注释和空行分割应合理。

2.源文件:每个JAVA源文件都包含一个单一的公共类或接口,且公共类必须是这里的第一个类。

3.开头注释:根据个人需要,最好列出类名,版本信息,日期,等等。

4.包和引入语句:第一个非注释行是包语句,其后可以跟引入语句。

5.缩进:使用4个空格作为缩进单位,或将TAB键的占位符设置为4.

6.排版:避免再一个语句里给多个变量赋值。参数列表的逗号后面应有一个空格。(包括for语句)二元运算符除了“.”,应该使用空格符将之与操作数分开。

7.行长度:尽量避免一行的长度超过150字符。

8.换行:每行只能有一个声明。两个方法之间使用空行。当表达式无法容纳在一行内的时候,可以用{}换行,在逗号或操作符前面断开,新的一行应该与同级的表达式对齐。

9.注释:注释不应写在大框里,注释里不应包括制表符和回退符等特殊字符。注释风格大概有四种:块,单行,尾端,行末。不要在应保持注释一致性的时候使用复数的注释风格。

10.javadoc注释:对类,接口,公用和保护类变量使用javadoc注释,必须包括描述,参数,返回值,异常的说明。

11.注释格式:方法的内部采用单行注释,不要和代码同一行。

12.类内部的成员变量:单行注释。

13.声明:一行一个声明。

14.初始化:尽量在声明局部变量的同事初始化。

15.布局:在代码块的开始处声明变量,将局部变量的作用域最小化。

16.类和接口的声明:方法名与其参数列表之前的左括号间不要有空格。左大括号位于声明语句的同行末尾。方法与方法之间以空行分隔。

17.简单语句:每行最多包含一条语句。

18.复合语句:左大括号应该位于起始行的末尾,右大括号应另起一行并与复合语句首行对齐。即使是单行的if-else语句或for语句,也建议加上大括号,这样可以有效防止因为添加语句后而忘了加大括号的行为。

19.返回语句:一个带返回值的语句一般不使用小括号,除了以下情况

return;

return myDisk.size();

return (size?size:defaultSize);

20.块语句:if,else,while,for语句必须有{},空格。{必须在一行之末,}在一行之头。

21.命名规范:包路径必须小写。类名应该是名词,或者是名词+动词,接口的第一个字母大写。多个单词合成的一个类名,每个单词首字母大写。数据访问用表明+DAO+方言方式。接口首字母为I。方法用驼峰命名法。数组用byte[] buffer;而不是byte buffer[];,根绝类名首字母小写,数组增加Arr后缀。变量用匈牙利命名。常量全大写,使用关键字final。中间用下划线分割单词。组件命名以相应组件结尾。

而如果你在一个项目中不遵守已经制定好的统一规范,那么不仅是给自己带来麻烦,也是给其他工作人员带来不便,在要进行整理的时候,你的不同,会带来不必要的交流麻烦。作为一个Java程序员,你一般是属于团队中的一员,你不遵守制定好的Java代码规范,其他人也不遵守那么你们的团队就得乱套了,所以面对Java代码规范的学习,不要觉得无趣,还是得用心记住,并且予以遵守。


【免责声明】本文部分系转载,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责,如涉及作品内容、版权和其它问题,请在30日内与我们联系,我们会予以重改或删除相关文章,以保证您的权益!

Java开发高端课程免费试学

大咖讲师+项目实战全面提升你的职场竞争力

  • 海量实战教程
  • 1V1答疑解惑
  • 行业动态分析
  • 大神学习路径图

相关推荐

更多
  • Java编程工具用哪个最好
    Java编程工具用哪个最好
    Java编程工具用哪个最好?Java编程工具的选择取决于个人的偏好、项目需求和开发环境。以下是一些常用的Java编程工具: 详情>>

    2024-04-03

  • 好用的Java编写软件
    好用的Java编写软件
    Java是一种广泛使用的编程语言,因其跨平台、安全性和稳定性而受到许多开发者的喜爱。Java被用于开发各种类型的软件,从桌面应用程序到企业级服务器端应用程序。以下是一些常见的、用Java编写的软件示例: 详情>>

    2024-04-02

  • Java测试工具有哪些?
    Java测试工具有哪些?
    Java测试工具有哪些?Java测试工具有很多,可以用于不同的测试阶段和目的,包括单元测试、集成测试、性能测试等。以下是一些流行的Java测试工具: 详情>>

    2024-04-02

  • Java有哪些课程?
    Java有哪些课程?
    Java是一种功能丰富且易于学习的编程语言,适用于多种不同的应用领域。目前,许多机构和在线平台都提供了丰富的Java相关课程,课程内容涵盖了Java的基础知识、高级特性以及实际应用等方面。以下是一些Java课程的示例: 详情>>

    2024-03-14

  • Java开班时间

    收起