Java程序编码规范.docx_第1页
Java程序编码规范.docx_第2页
Java程序编码规范.docx_第3页
Java程序编码规范.docx_第4页
全文预览已结束

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

Java程序编码规范开发程序时,往往会有很多人参与,为了使程序的结构与代码风格标准化,以便于使每个参与开发的人员尽可能直观地查看和理解其它人编写的代码,需要在编码之前制定一套统一 的编码规范。下面介绍一套Java语言中常用的程序编码规范供读者参考。命名规则数据类型简写规则程序中定义常量、变量或方法等内容时,常常需要指定类型。下面介绍一种常见的数据类型简写规则,如表1所示。表1 数据类型简写规则数据类型简写整型int字符串str布尔型bl短整型sint长整型lint单精度浮点型flt双精度浮点型dbl字节型bt变量及常量名称命名规则根据不同的程序需要,编写代码时需要定义一定的变量或常量。下面介绍一种常见的变量及常量的命名规则。变量:java中变量由单个或者多个单词组成,其中单个单词或多个单词的第一个单词所有字母小写,其余单词首字母大写,并且不能使用java中的关键字。例如:userName。变量的名称要有意义,能从变量名称中理解其含义。常量:常量是在程序运行过程中值不能改变的量。常量也要使用有意义的名称,并且单词的所有字母要大写,如果由多个单词组成,就使用下划线分割。例如USER_NAME。类命名规则使用完整的单词,避免使用缩写。类名称的首字母要大写。尽量使用名称。类通常表示一种对象类型,而对象一般使用具有名词性质的名称。不要使用$或者下划线作为前缀。尽管在Visual Basic 和Visual C+等其它语言中,这是非常普遍的,但在java中不提倡使用。自定义异常类命名通常要以Exception结尾,但应该尽量避免自定义异常类。避免将多个类放在一个文件里。初始化类的实例时,除非非常必要,否则不要赋值为null。成员变量命名规则成员变量名称通常都是名词,命名规则与变量相同。例如name和age等。成员变量名称不能与java关键字相同。尽量不要提供public和protected的成员变量,使用设置器和访问器操作它们。方法命名规则方法名通常都是动词,因为方法用来实现一个对象的行为功能,例如read()、write()、start()和stop()等。当重载方法是,参数的顺序和声明时的参数顺序要一致。定义方法名时不要使用缩写。如果认为应用程序中的某些项目使用缩写,那么请将这些情况加上注释,并确保每个人在所有的时间内都使用这些缩写,一定不要在某些方法中对某些单词进行缩写,而在别的地方却不使用缩写。一个方法的代码长度最好不要超过25行。避免方法中超过5个参数的情况,如果超过了,则应使用自定义类(即JavaBean)来传递多个参数。接口命名规则接口名称的首字母要大写。接口名称尽量具有描述性,并使用形容词,因为接口常常用于给一个类添加某种能力,例如Runnable。避免一个接口中只有一个成员,尽量使每个接口中包含35个成员。接口中的成员不应该超过20个。尽量少使用匿名接口实现。代码版式统一代码缩进每个项目都应该根据实际情况建立统一的代码缩进标准,例如统一缩进一个Tab制表符,这样代码看起来非常美观,而且层次感很清楚,方便阅读代码。合理使用空行在不同的功能的代码段之间使用空行分割。在每个类声明之后、每个方法声明之后都要加空行。在一个方法体内,逻辑上密切相关的语句之间不加空行,其它地方应该加空行分割。代码换行一行代码只做一件事情,如定义一个变量,或只编写一条语句。if、switch、for、foreach格式的循环、while等语句独占一行,执行语句不能紧跟其后,而且不论执行语句有多少都应该加。代码行最大长度应该控制在7080个字符以内,代码不要过长,否则不便于查看。长表达式要在低优先级运算符处拆分成新行,运算符放在新行之首(以便突出运算符)。拆分的新行要适当缩进,以便使排版整齐。空格的使用关键字后面应该加空格,否则无法解析关键字。if 、for、while等控制语句关键字后面应该加空格,然后再跟左大括号,以便突出关键字。方法名后面不要加空格,而应紧跟左小括号,以便与关键字区分。赋值运算符、比较运算符、算术运算符、逻辑运算符和位运算符等二元运算符的前后应该加空格。一元运算符如“!”,“+”,“”,“&”等前后不加空格。类似“”,“.”这类符号的后面不加空格。对于表达式比较长的if语句和for语句,为了看上去更加紧凑,可以适当去掉一些空格。代码注释注释的目的文字说明代码的作用(即为什么要用编写该代码,而不是如何编写)。指出该代码的编写思路和逻辑思路。代码中的重要转折点。使代码的阅读者不必在他们的头脑中仿真运行代码的执行过程。代码注释规范方法体内使用类似“/”的形式进行注释,前面需要使用空格进行对齐时,使用Tab键代替空格键。对类进行JavaDoc注释,说明类的含义和作用以及作者等信息。对方法进行JavaDoc注释,说明方法的作用和使用的参数含义,以及方法可能抛出的异常。避免对很浅显易懂的语句进行注释说明。代码应该能做到自我解释代码作用的功能。好的代码可以通过可读的变量和方法名了解该段代码的作用,而不需要过多的注释。逻辑性较强的地方加入注释,说明这段程序的逻辑是怎样的,以方便其它人的理解,并且这样还可以在一定程度上排除BUG。使用注释来说明何时可能出错和为什么出错。在编写代码前进行注释。避免形成注释框。用星号围成的注释框,右边的星号看起来很好,但它们给编写或者编辑注释的人增加了许多工作。增强注释的可读性。注释是供人阅读,而不是让计算机阅读,所以应该使用完整的语句。对注释进行缩进,使之与随后的语句对齐。注释通常位于它们要说明的代码的前面,为了从视觉上突出注释与代码之间的关系,请将注释缩进,使之与代码处于同一个层次上。在每个if语句的前面加上注释。在每个switch语句的前面加上注释。在每个循环语句的前面加上注释。数据库编程命名规范数据库命名规范数据库命名以字母“db_”开头(小写),后面加数据库相关英文单词或缩写。下面将举例进行说明,如表2所示。表2 数据库命名数据库名称描述Db_PWMS企业人事管理系统数据库数据表命名规范数据表以字母“tb_”开头(小写),后面加数据库相关英文单词或缩写。下面将举例进行说明,如表3所示。表3 数据表命名数据表名称描述tb_LOGIN登陆信息表字段命名规范字段一率采用英文单词或词组(可利用翻译软件)命名,如找不到专业的英文单词或词组,可以用相同意义的英文单词或词组代替。下面将举例进行说明,如表4所示。表4 字段命名字段名称描述name名字password密码视图命名规范视图命名以字母“view_”开头(小写),后面加上表示该视图作用的相关英文单词和缩写。下面将举例进行说明,如表5所示。表5 视图命名字段名称描述view_AdminInfo查看管理员信息的视图view_Sell查看销售信息的视图view_AllTypeUser查看所有类别的用户的视图存储过程命名规范存储过程命名以字母“proc_”开头(小写),后面加表示该存储过程作用的相关英文单词或缩写。下面将举例进行说明,如表6所示。表6 存储过程命名字段名称描述proc_Login实现登陆功能的存储过

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论