JAVA代码书写规范汇总详解

2023-08-19 21:48:06 78

一般原则

命名的字母大小写问题

方法的命名

类中获取值方法，一般要求被方法名使用被访问字段名，前面加上前缀get，如getLastUser(),getUserCount()
返回布尔型的判断方法一般要求方法名使用单词is做前缀，如isPersistent(),isString()。或者使用具有逻辑意义的单词，例如equal或equals
用于修改某些设置的方法（一般返回类型为void）：被访问字段名的前面加上前缀set，如setFirstName(),setLastName()，setWarpSpeed()。
已办的方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用一个生动的动词，第一个字母小写，如openFile(),addAccount()。
接口：首字母大写，后缀Impl例如:classContainerImpl
异常类：首字母大写，后缀Exception例如:DataNotFoundException
抽象类：首字母大写，前缀Abstract例如:AbstractBeanDefinition
Test类：首字母大写，后缀Test例如:publicLocationnewLocation()

Java注释约定

类的整体注释：遵循JavaDoc的规范，在每一个源文件的开头注明该CLASS的作用,作简要说明,并写上源文件的作者,编写日期。如果是修改别人编写的源文件，要在修改信息上注明修改者和修改日期。

例如：

/**
*@（#）:CLASSNAME.java
*@description:Descriptionofthisjava
*@author:PROGRAMMER'SNAMEYYYY/MM/DD
*@version:VersionNo.
*@modify:
*@Copyright:版权由拥有
*/

例如：

/**
*方法的描述
*
*
*@param参数的描述
*@return返回类型的描述
*@exception出错信息的描述
*/

行注释：使用//…的注释方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面一行或同一行。
块注释：使用/**和*/注释的方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面。
注释哪些部分：类的目的（即类所完成的功能）、设置接口的目的以及应如何被使用、成员方法注释（对于设置与获取成员方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么？返回什么？）、普通成员方法内部注释（控制结构、代码做了些什么以及为什么这样做，处理顺序等）、实参和形参的含义以及其他任何约束或前提条件、字段或属性描述。而对于局部变量，如无特别意义的情况下不加注释。

JAVA文件声明顺序

类或接口应该按以下顺序声明（其实是加载顺序的问题）：

包的定义
impot类（输入包的顺序、避免使用*）输入包应该按照java.*.*，javax.*.*，org.*.*，com.*.*的顺序import在import的时候不应该使用*(例如:java.util.*)
类或接口的定义
静态变量定义，按public，protected，private顺序
实例变量定义，按public，protected，private顺序
构造方法
方法定义顺序按照public方法(类自己的方法)，实现接口的方法，重载的public法，受保护方法，包作用域方法和私有方法。建议：类中每个方法的代码行数不要超过100行。
内部类的定义

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。