H5W3
当前位置:H5W3 > java > 正文

【Java】想成为编程大佬,看看这些Java代码开发规范吧!

作为一名开发人员,当你接手他人的项目时,且当你阅读他人的代码时,是有没有遇到脑袋充血,感觉Java要把你“送走”的感觉呢?我们在用Java开发技术进行开发前,一定要牢牢恪守Java的开发标准,唯有如此你的Java开发之路才能更为顺畅。而掌握相应的Java开发技巧,则能够让你作业起来事半功倍。

一.排版规范:

  1. 关键词(或变量)和操作符之间加一个空格。例如:int iCont = 1;//操作符和值之间有一个空格。
  2. 相对独立的代码块与块之间加空行。例如:两个方法之间需要用空格隔开。
  3. 较长的语句、表达式等要分成多行书写。
  4. 长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
  5. 代码的新行与上一行根据逻辑关系要进行适应的缩进(一个 table 键),使排版整齐,语 句易读。
  6. 不允许把多个短语句写在一行中,即一行只写一条语句。
  7. 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。采用 TABLE 键缩进。
  8. 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。
  9. 若函数或过程中的参数较长,则要进行适当的划分。
  10. 用大括号‘{‘和‘}’界定一段程序块时,编写程序块时‘{‘和 ‘}’应各独占一行 并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、 枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方 式。

JAVA代码开发规范(WISHSOFT)

  1. 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】想成为编程大佬,看看这些Java代码开发规范吧!

五.方法编写规范

1.对成员方法,不要轻易的采用public的成员变量。主要的修饰符有public, private, protected, 无

2.空方法中方法声明和函数体可都在一行。如: void func(){}

3.方法和方法之间空一行

4.方法的文档注释放在方法的紧前面,不能空一行。

5.避免过多的参数列表,尽量控制在5个以内,若需要传递多个参数时,当使用一个容纳这些参数的对象进行传递,以提高程序的可读性和可扩展性

6.方法中的循环潜套不能超过2层

7.对于设计期间不需要子类来重载的类,尽量使用final

8.每个方法尽量代码行数尽量不要超过100行(有效代码行,不包括注释),但必须保证逻辑的完整性

9.接口中的方法默认级别为protected,只有很确认其它子系统的包会调用自己子系统的接口中的方法时,才将方法暴露为public.

六.语言使用及书写规范

1.避免变量的定义与上一层作用域的变量同名。

2.方法与方法之间用需要用一空行隔开

3.局部变量在使用时刻声明,局部变量/静态变量在声明时同时初始化

4.在与常数作比较时常数放在比较表达式的前面如:

`if(“simpleCase”.equals(obj))… if(null == obj)….`
*   1

5.return语句中,不要有复杂的运算。

6.switch语句,需要一个缺省的分支

写在最后:

本文到这里就结束了! 如果本文有任何错误,请批评指教,不胜感激 !

零基础学习Java编程,可以加入我的十年Java学习园地。

【Java】想成为编程大佬,看看这些Java代码开发规范吧!

本文地址:H5W3 » 【Java】想成为编程大佬,看看这些Java代码开发规范吧!

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址