java开发规范

hbh 开发规范文档

一:目的

使本组织能以标准的,规范的方式设计和编码。通过建立编码规范,以使每个开发人员

养成良好的编码风格和习惯;并以此形成开发小组编码约定,提高程序的可靠性,可读性,

可修改性,可维护性和一致性等,增进团队间的交流,并保证软件产品的质量。

二:代码组织与风格

1:长度:为便于阅读和理解,单个函数的有效代码长度当尽量在100行以内(不包括注行),

当功能模块过大时往往采用使用子函数将相应的功能抽取出来,这也有利于提高代码的重用度。

2:间隔:类,方法及功能块间等应以一个空行相隔,以增加可读性,但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。

三:注释

1:注释应该增加代码的清晰度。代码注释的目的时要使代码更易于被其他开发人员等理解。

2:保持注释的简洁。

3:注释信息应该包括代码的功能。

4:除变量定义等较短语句的注释使用行尾注释外,其他注释当避免使用行尾注释

5:JavaDoc规范

对类,方法,变量等注释需要符合

javadoc规范,对每个类,方法都应详细说明其功能条件,参数等。

1)类,接口注释

在类,接口定义之前当对其进行注释,包括类,接口的目的,作用,功能,继承于何种父类,实现的接口,实现的算法,使用方法,示例程序等。

2)方法注释

以明确该方法功能,各参数含义以及返回值等。

3)其他注释

应对重要的变量及不易理解的分支条件表达式加以注释,以说明其含义等。

四 命名规范

1:对变量,类,接口及包的命名应该使用英文或者是汉语首字母。更不可以使用汉字来进行命名。采用大小写混合,提高名字的可读性。一般应该采用小写字母,但时类和接口的名称的首字母,以及任何中间单词的首字母应该大写。包名全部小写。

2:尽量少用缩写,但如果一定要用,当使用公共缩写和习惯缩写等,如implement可缩为impl,manager可缩写成mgr等。

3:包名一般以项目或模块名命名,少用缩写和长名,一律小写。包名按照如下规定组成[基本包].[项目名].[模块名].[子模块名].…. 如:org.skyinn.skyhome.dao.hibernate。 不得将类直接定义在基本包下,所有项目中的类,接口等都当定义在各自的项目和模块包中。

4:类,接口

所有单词首字母大写,最好能够见名知意。一般采用名词或者是汉语首字母。或able,dao,dto,bean后缀。

5:字段

常量采用完整的英文大写单词,单词之间用下划线连接,如DEFAULT_VALUE.

6:变量和参数对不易识别出该变量类型的变量应使用类型缩写作其前缀,如字符串使用strXXX,boolean使用isXXX,hasXXX等等。除第一个单词外其余单词的首字母大写。

7:集合

采用复数名称来表示队列中存放的对象类型,名词采用完整的英文描述。例如:Vector vProducts= new Vector(); Array aryUsers= new Array();

8:方法

方法的名称应采用完整的英文描述,大小写混合使用:所有中间单词的第一个字母大写。方法名称的第一个单词常常采用一个强烈动作色彩的动词。取值类使用get前缀,设置类使set

前缀。例如getName(),setSarry()。

9:异常类名由表示该异常类型的单词和Exception组成,如ActionException。异常实例一般使用e,ex等。

10:数组的命名

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

关于hbh项目的特殊规定:

一.controller层规范:

1.在controller层中查询类接口全部以quary*开头。查询本地使用quaryList。查询中登quaryZdList。

2. 在controller层提交类接口全部以to*开头。查询本地使用toZzh。

3. url地址一般是以方法名称。如果有特殊情况。与本规范作者沟通。并且添加到此规范中。

时间: 2024-10-12 03:07:19

java开发规范的相关文章

谈谈Google与微信H5牛牛的Java开发规范

多年前,Google发布微信H5牛牛搭建平台(h5.fanshubbs.com)来定义Java编码时应遵循的微信牛牛Q_1687054422规范:今年年初阿里则发布阿里巴巴Java 开发手册,并随后迭代了多个版本,直至9月份又发布了微信H5牛牛.这两大互联网巨头的初衷,都是希望能够统一标准,使业界编码达到一致性,提升沟通和研发效率,这对于我们码农无疑是很赞的一笔福利呀.笔者将两份规范都通读了一遍,其中列举的不少细则跟平时的编码习惯基本是符合的,不过还是有不少新奇的收获,忍不住记录在此,供日后念念

eclipse安装阿里巴巴java开发规范插件

阿里巴巴java开发规范插件 作为JAVA开发人员,始终没有一个明确的规范,何为好代码,何为坏代码,造成不同人的代码风格不同,接手别人代码后改造起来相当困难.前不久,阿里巴巴发布了<阿里巴巴Java开发手册>得到了业界一致好评,于是,阿里再次发力,完成了基于<阿里巴巴Java开发手册>的插件.有IDEA.Eclipse两个版本,并且支持中英双语,使用起来非常简单高效.官方[Github仓库]:https://github.com/alibaba/p3c 插件安装环境:JDK1.8,

阿里云JAVA开发规范考试总结

JAVA开发手册考试总结 编程规范 POJO(Plain Ordinary Java Object): POJO 专指只有 setter / getter / toString的简单类,包括DO/DTO/BO/VO等. DO(Data Object):此对象与数据库表结构一一对应,通过 DAO 层向上传输数据源对象. DTO(Data Transfer Object):数据传输对象,Service 或 Manager 向外传输的对象. BO(Business Object):业务对象,由 Ser

阿里巴巴Java开发规范手册(三)

(六)并发处理 1.获取单例对象须要保证线程安全,其中的方法也要保证线程安全 2.创建线程或线程池时 请指定有意义的线程名称,方便出错时回溯 3.线程资源必须通过线程池提供,不允许在应用中自行显示创建线程 4.线程池不允许使用Executors去创建,而是通过ThreadPoolExecutor的方式,    这样的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险 (1).FixedThreadPool 和SingleThreadPool 允许的请求队列长度为Integer.MAX

java开发规范总结_代码编码规范

规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本原则 强制性原则:     1.字符串的拼加操作,必须使用StringBuilder:     2.try…catch的用法 try{ }catch{Exception e e.printStackTrace(); }finally{ }//在最外层的Action中可以使用,其它地方一律禁止使用: try{ //程序代码 }catch(Exception e){ //为空,什么都不写 }//在任何场景中都禁止使用 try{ }catch

阿里巴巴java开发规范

一.编程规约 (一) 命名规约 1. [强制]所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Object / name_ / name$ / Object$ 凡是以两个或一个下划线开始,后面紧跟着一个大写字母的标识符,不管它出现在哪里,都是保留给编译程序或标准库函数使用的. 此外,凡是以一个下划线开始,后面不管跟着什么内容的标识符,如果它出现在文件范围内(即它不是出现在一个函数内),那么它也是被保留的. 如果你用一个保留

Java开发规范摘录

对于规范的 JAVA 派生类,尽量用 eclipse工具来生成文件格式,避免用手写的头文件/实现文件. 尽量避免一行的长度超过 200 个字符,因为很多终端和工具不能很好处理之.缩进8格 ,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列. 如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理. 对于构造函数,它应该用递增的方式写,即将参数多的构造方法写在后面 /*- 单行注释之前应该有一个空行.//然而,它可以用来注释掉连续多行的代码段. /** * 声

java开发规范总结_代码注释规范

规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂   2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了.如果注释太复杂说明程序需要修改调整,使设计更加合理.   3.注释不仅描述程序做了什么, 还要描述为什么要这样做,以及约束   4.对于一般的getter.setter方法不用注释   5.注释不能嵌套   6.生成开发文档的需要用中文编写 2.三种注释方式说明 1.文档注释 /** */ 可以对用多行,一般用来对类.接口.成员方

Java开发规范总结

 Service / DAO 层方法命名规约: 1 ) 获取单个对象的方法用 get 做前缀.2 ) 获取多个对象的方法用 list 做前缀.3 ) 获取统计值的方法用 count 做前缀.4 ) 插入的方法用 save( 推荐 ) 或 insert 做前缀.5 ) 删除的方法用 remove( 推荐 ) 或 delete 做前缀.6 ) 修改的方法用 update 做前缀. 领域模型命名规约:1 ) 数据对象: xxxDO , xxx 即为数据表名.2 ) 数据传输对象: xxxDTO , x