JAVA代码开发规范

一.开发工具规范:

1. 开发工具经项目负责人调试后统一确定。

2. 开发工具一经确定不允许集成任何非统一插件,若有需要,经项目负责人同意后统一为 项目组成员添加。

3. 开发工具的编码格式不允许修改。

二.排版规范:

1. 关键词(或变量)和操作符之间加一个空格。 例如:int iCont = 1;//操作符和值之间有一个空格。

2. 相对独立的代码块与块之间加空行。 例如:两个方法之间需要用空格隔开。

3. 较长的语句、表达式等要分成多行书写。

4. 长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

5. 代码的新行与上一行根据逻辑关系要进行适应的缩进(一个 table 键),使排版整齐,语 句易读。

6. 不允许把多个短语句写在一行中,即一行只写一条语句。

7. 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。采用 TABLE 键缩进。

8. 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。

9. 若函数或过程中的参数较长,则要进行适当的划分。

10. 用大括号‘{'和‘}'界定一段程序块时,编写程序块时‘{'和 ‘}'应各独占一行 并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、 枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方 式。

JAVA代码开发规范(WISHSOFT)

11. main 方法:如果 main(String[]) 方法已经定义了, 那么它应该写在类的底部.

三.命名规范:

1. Package(包)的命名

Package 的名字应该都是由一个小写单词组成。 例如:package com.wish;

2. Class 的命名

Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其

中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。 例如:

public class DatabaseOperator {
}

3. Class 中成员变量的命名 变量的名字必须用一个小写字母开头,后面的单词用大写字母开头,不需要数据类型前

缀。 例如:userName,size。

4. Class 中 Static Final 变量的命名

static Final 变量的名字应该都大写,并且指出完整含义。

例如:

public static final String DB_CONFIG_FILE_PATH ="com.neu.etrain.dbconfig";

5. Class 中方法的命名 方法的名字开头的单词必须用一个小写字母,后面的单词用大写字母开头。 例如:setName() , getMethod()。

6. 方法声明中参数命名 使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字。 例如:

public void setCounter(int size)
{

JAVA代码开发规范(WISHSOFT)

this.size = size;
    }

7. 方法内变量的命名

Class 中成员变量的命名。

8. 数组的命名

数组应该总是用下面的方式来命名: byte[] buffer;而不是: byte buffer[];

9. 分页中每页列表数量的变量使用 pageSize,当前的所在的页号为 pageNumber。

四.注释规范:

1. 注释要简单明了。

2. 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

3. 在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二 义性。保持注释与其描述的代码相邻,即注释的就近原则。

4. 变量、常量的注释应放在其上方相邻位置或右方,不可放在下面。

5. 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存 取时注意事项等的说明。

6. 类,方法的注释采用 eclipse 自动生成方法。

当把一个类,或方法的声明写完整后,在类,方法的正上方(不许有空格)在英文输入 法状态下输入:/** 后,系统会自动生成他们的注释模板,我们只需要填写相应的说明文字 即可,注意:/**的下一行一定要写功能说明。

7. 具体要求说明:

n 声明性(变量定义类)一定要有注释。例如:String myName; //用户名 n 类定义必须生成文档(JavaDoc)注释。

n 方法必须生成文档(JavaDoc)注释(包括实体类的set,get方法)。 n 成员变量必须生成文档(JavaDoc)注释。

n 方法中的逻辑部分由程序编写人根据复杂情况自行书写。

8. 类定义的注释信息,包括:作者;日期;模块功能描述(如功能、主要算法、内部各部

分之间的关系、该文件与其它文件关系等);本文件历史修改记录;版本信息等。

/**
* 干什么用的(描述信息)

JAVA代码开发规范(WISHSOFT)

* @author lifw20080320
* @modify lifw20080321
* @modify lifw20080322 (如果有多个,依次写多个@modify) * @copyright wishsoft
**/

9.javadoc 注释标签语法

@author 对类的说明 标明开发该类模块的作者

@version 对类的说明 标明该类模块的版本

@see 对类、属性、方法的说明 参考转向,也就是相关主题 @param 对方法的说明 对方法中某参数的说明

@return 对方法的说明 对方法返回值的说明

@exception 对方法的说明 对方法可能抛出的异常进行说明

五.基本数据类型前缀表(其他对象类型,随时补充):

Java 中数据类型

数据类型前缀

int

i

String

str

char

c

long

l

float

f

double

d

boolean

b

short

s

byte

byte

vector

v

六.日志组件使用规范(log4j)

1. Log 中的方法使用:

a) log.debug()是放在代码行中间,用来调试时输出使用,永久保留,不用删除。

b) log.error()是放在 try{}catch(){}中 catch 部分里的用来输出 error 异常信息使用的。

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持我们!

(0)

相关推荐

  • Java代码注释规范详解

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

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

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

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

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

  • JAVA代码开发规范

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

  • 养成良好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代码书写规范汇总详解

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

  • 浅析php与数据库代码开发规范

    1.PHP中对各类变量内容的命名规范  (1)目录命名.文件命名.局部变量命名: 使用英文名词.动词,以下划线作为单词的分隔,所有字母均使用小写 目录:upload.templates.install.manage--文件:index.php . register.php  . config.php--变量:$user , $pay_time , $pay_del_cont -- (2)全局常量命名:使用英文名词.动词,所有字母都使用大写,以下划线分隔每个单词 define( 'WEBSITE_

  • 浅析PHP开发规范

    基本约定 源文件 代码使用<?php开头,忽略闭合标签?> 文件格式必须是无BOM UTF-8格式 一个文件只声明一种类型,如class和interface不能混写在一个源文件中 缩进 使用4个空格来缩进,IDE可以设置 行长度 每行120个字符 关键字 所有关键字均为小写,如true.false 命名 类名为大驼峰法,如UserModel 类方法名为小驼峰法,如getUserId() 函数使用小写字母加_组合,如get_cookie() 变量名使用小驼峰法,如$userId 常量定义为大写字

  • Java项目开发命名规范(动力节点Java学院整理)

    最好使用英文,不要用汉语拼音 1:包(package):用于将完成不同功能的类分门别类,放在不同的目录(包)下,包的命名规则:将公司域名反转作为包名.比如www.bjpowernode.com 对于包名:每个字母都需要小写.比如:com. bjpowernode.test;该包下的Test类的全名是:com. bjpowernode.Test.java .如果定义类的时候没有使用package,那么java就认为我们所定义的类位于默认包里面(default package). 2:类:首字母大写

  • java代码规范review异常事故记录

    目录 前言 一个任务处理例子 不要生吞异常 还有问题! End 前言 不久之前,部门进行了一次代码评审. 代码整体比较简单,该吹B的地方都已经吹过了,无非是些if else的老问题而已.当翻到一段定时任务的一步执行代码时,我的双眼一亮,觉得该BB两句了. 谁知这群家伙,评审的时候满满的认同感,但评审结束不久,就给我冠了个事B的称号. 今天我就把当时的这些话儿整理整理,让大家说道说道,我到底是不是个事B.淦! 一个任务处理例子 代码的结构大体是这样的. 通过定时,这段代码每天晚上凌晨都要对数据库的

  • Java代码规范与质量检测插件SonarLint的使用

    目录 1.SonarLint 2. SonarQube 3. Alibaba代码规约插件 4. 文档 1.SonarLint SonarLint是一个代码质量检测插件,可以帮助我们检测出代码中的坏味道 下载与安装 在需要检测的单个文件或者单个项目上右键 --> Analyze --> Analyze with SonarLint 或者选中文件或目录,点击菜单栏 Analyze --> Analyze with SonarLint 我们还可以禁用某些规则 如果需要同步自定义的规则时,可以绑

随机推荐