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注释约定

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

例如：

/**
* @（#）:CLASSNAME.java
* @description: Description of this java
* @author: PROGRAMMER'S NAME YYYY/MM/DD
* @version: Version No.
* @modify:
* @Copyright: 版权由拥有
*/
  • 类中方法的注释：遵循JavaDoc的规范，在每个方法的前部用块注释的方法描述此方法的作用，以及传入，传出参数的类型和作用，以及需要捕获的错误。

例如：

/**
* 方法的描述
*
*
*@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. 内部类的定义

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

赞 (0)

相关推荐

  • 养成良好java代码编码规范

    一.基本原则 强制性原则: 1.字符串的拼加操作,必须使用StringBuilder: 2.try-catch的用法 try{ }catch{Exception e e.printStackTrace(); }finally{ }//在最外层的Action中可以使用,其它地方一律禁止使用: try{ //程序代码 }catch(Exception e){ //为空,什么都不写 }//在任何场景中都禁止使用 try{ }catch{Exception e throw new runtimeExce

  • Java代码注释规范(动力节点整理)

    代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在日常开发中使用的代码注释规范,供大家参考下. 1. 注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2. 注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害

  • 8种常见的Java不规范代码

    8种常见的Java不规范代码

    在工作上,我最近对一个现有的Java项目代码进行了清理.完成之后,我发现了一些反复出现的不规范代码.所以,我把它们整理成了一个列表出来分享给我的同行希望能引起注意并改善代码的质量和可维护性. 这个列表不区分顺序,全部来自一些代码质量检查工具,如 CheckStyle, FindBugs 和PMD. 在Eclipse中格式化源代码并管理import语句 Eclipse提供了自动格式化源代码和管理import语句的功能(并移除未使用的语句).你可以使用下面的快捷键来使用这些功能. Ctrl + Sh

  • Java代码注释规范详解

    Java代码注释规范详解

    代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害. 3.基本注释(必须加) (a) 类(接口)的注释 (b) 构造函

  • JAVA代码开发规范

    一.开发工具规范: 1. 开发工具经项目负责人调试后统一确定. 2. 开发工具一经确定不允许集成任何非统一插件,若有需要,经项目负责人同意后统一为 项目组成员添加. 3. 开发工具的编码格式不允许修改. 二.排版规范: 1. 关键词(或变量)和操作符之间加一个空格. 例如:int iCont = 1;//操作符和值之间有一个空格. 2. 相对独立的代码块与块之间加空行. 例如:两个方法之间需要用空格隔开. 3. 较长的语句.表达式等要分成多行书写. 4. 长表达式要在低优先级操作符处划分新行,操

  • JAVA代码书写规范汇总详解

    一般原则 尽量使用完整的英文描述符 采用适用于相关领域的术语 采用大小写混合增强可读性 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 避免使用长的名字 避免使用类似的名字,或者仅仅是大小写不同的名字 避免使用下划线(除静态常量等) 命名的字母大小写问题 包名: 字母全小写 例如: cn.coderstory.Activity.Main 类,接口 :首字母大写,其他全小写 例如: class Container 方法,变量 :第二个单词开始首字母大写 例如: seedMessage

  • Spring装配Bean之用Java代码安装配置bean详解

    前言 本文主要给大家介绍了关于Spring之利用Java代码安装配置bean的相关内容,尽管通过组件扫描和自动装配实现Spring的自动化配置很方便也推荐,但是有时候自动配置的方式实现不了,就需要明确显示的配置Spring.比如说,想要将第三方库中的组件装配到自己的应用中,这样的情况下,是没办法在它的类上添加 @Compnent和 @Autowired注解的. 在这种情况下,需要使用显示装配的方式,可以分别通过Java和XML实现,推荐使用Java的方式,因为更加强大,类型安全并且重构友好,因为

  • 基于Java代码操作Redis过程详解

    基于Java代码操作Redis过程详解

    Jedis简介 实际开发中,我们需要用Redis的连接工具连接Redis然后操作Redis, 对于主流语言,Redis都提供了对应的客户端: 提供了很多客户端 官方推荐的是Jedis 托管地址:https://github.com/xetorthio/jedis 要使用redis首先得下载pom依赖 <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId&g

  • Java基础之命名规范的详解

    Java基础之命名规范的详解

    前言 在编程的世界里,每种语言都有自己的一些规范.下面,就带你了解Java命名规范.对于程序员来说,如果想学好一门语言,想要自己写出来的代码能被他人轻易地读懂,深入的学习命名规范是非常必要的一件事情.在这里,总结了一下Java的命名规范. 一.Java命名规范: 1. 项目名称全部小写; 2. 包名全部小写; 3. 类名首字母大写,如果类名由多个字母组成,每个首字母都需要大写; 如:public class MyFirstClass{} 4. 变量名和方法名首字母小写,如果由多个单词组成,其后的

  • java 实现单链表逆转详解及实例代码

    java 实现单链表逆转详解 实例代码: class Node { Node next; String name; public Node(String name) { this.name = name; } /** * 打印结点 */ public void show() { Node temp = this; do { System.out.print(temp + "->"); temp = temp.next; }while(temp != null); System.o

  • Java 装箱与拆箱详解及实例代码

    Java 装箱与拆箱详解 前言: 要理解装箱和拆箱的概念,就要理解Java数据类型 装箱:把基本类型用它们相应的引用类型包装起来,使其具有对象的性质.int包装成Integer.float包装成Float 拆箱:和装箱相反,将引用类型的对象简化成值类型的数据 Integer a = 100; 这是自动装箱 (编译器调用的是static Integer valueOf(int i)) int b = new Integer(100); 这是自动拆箱 看下面一段代码 m1 public class

  • java 实现汉诺塔详解及实现代码

    java 实现汉诺塔详解及实现代码 汉诺塔问题:有三根柱子A,B,C,其中A上面有n个圆盘,从上至下圆盘逐渐增大,每次只能移动一个圆盘,并且规定大的圆盘不能叠放在小的圆盘上面,现在想要把A上面的n个圆盘全部都移动到C上面,输出移动的总步数以及移动的过程 分析: //先求出移动的总步数 1,假设g(n)表示n个圆盘时的移动总的步数,当n=1时,g(1)=1; 2.现在可以把g(n)进行细分为三步: 1>先将n-1个圆盘从A通过C移动到B上面,相当于将n-1个圆盘从A移动到C,因此需要g(n-1)步

  • java中的静态代码块、构造代码块、构造方法详解

    运行下面这段代码,观察其结果: package com.test; public class HelloB extends HelloA { public HelloB() { } { System.out.println("I'm B class"); } static { System.out.println("static B"); } public static void main(String[] args) { new HelloB(); } } cla

  • java LRU(Least Recently Used )详解及实例代码

    java LRU(Least Recently Used )详解 LRU是Least Recently Used 的缩写,翻译过来就是"最近最少使用",LRU缓存就是使用这种原理实现,简单的说就是缓存一定量的数据,当超过设定的阈值时就把一些过期的数据删除掉,比如我们缓存10000条数据,当数据小于10000时可以随意添加,当超过10000时就需要把新的数据添加进来,同时要把过期数据删除,以确保我们最大缓存10000条,那怎么确定删除哪条过期数据呢,采用LRU算法实现的话就是将最老的数据

随机推荐