当前位置:主页 > 软件编程 > JAVA代码 >

JAVA代码书写规范汇总详解

时间:2020-10-17 23:23:18 | 栏目:JAVA代码 | 点击:

一般原则

  1. 尽量使用完整的英文描述符
  2. 采用适用于相关领域的术语
  3. 采用大小写混合增强可读性
  4. 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一
  5. 避免使用长的名字
  6. 避免使用类似的名字,或者仅仅是大小写不同的名字
  7. 避免使用下划线(除静态常量等)

命名的字母大小写问题

  1. 包名: 字母全小写 例如: cn.coderstory.Activity.Main
  2. 类,接口 :首字母大写,其他全小写 例如: class Container
  3. 方法,变量 :第二个单词开始首字母大写 例如: seedMessage
  4. 常量: 大写,单词用“_”分割 例如: final static MIN_WIDTH = 4
  5. 接口 :首字母大写 ,后缀Impl 例如: class ContainerImpl
  6. 异常类: 首字母大写, 后缀Exception 例如: DataNotFoundException
  7. 抽象类 :首字母大写, 前缀Abstract 例如: AbstractBeanDefinition
  8. Test类: 首字母大写, 后缀Test 例如: public Location newLocation()

方法的命名

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

Java注释约定

例如:

/**
* @(#):CLASSNAME.java
* @description: Description of this java
* @author: PROGRAMMER'S NAME YYYY/MM/DD
* @version: Version No.
* @modify:
* @Copyright: 版权由拥有
*/

例如:

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

JAVA文件声明顺序

类或接口应该按以下顺序声明(其实是加载顺序的问题):

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

您可能感兴趣的文章:

相关文章