`

JAVA程序员不可不留意的编码规范

    博客分类:
  • dos
阅读更多

好的编码规范可以尽可能的减少一个软件的维护本钱 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发职员来维护......

 

 

 

1、规范存在的意义

 

应用编码规范对于软件本身和软件开发职员而言尤为重要,有以下几个原因:

1、好的编码规范可以尽可能的减少一个软件的维护本钱 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发职员来维护;

2、好的编码规范可以改善软件的可读性,可以让开发职员尽快而彻底地理解新的代码;

3、好的编码规范可以最大限度的进步团队开发的合作效率;

4、长期的规范性编码还可以让开发职员养成好的编码习惯,甚至锻炼出更加严谨的思维;

 

2、命名规范

 

一般概念

 

1、尽量使用完整的英文描述符

 

2、采用适用于相关领域的术语

 

3、采用大小写混合使名字可读

 

4、尽量少用缩写,但假如用了,必须符合整个工程中的同一定义

 

5、避免使用长的名字(小于 15 个字母为正常选择)

 

6、避免使用类似的名字,或者仅仅是大小写不同的名字

 

7、避免使用下划线(除静态常量等)。

 

标识符类型说明

 

1、包( Package )的命名

Package 的名字应该采用完整的英文描述符,都是由一个小写单词组成。并且包名的前缀总是一个顶级域名, 通常是 com、edu、gov、mil、net、org 等;

如: com.yjhmily.test

 

2、类( Class )的命名

 

类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。

 

使用完整单词,避免缩写词 ( 除非工程内有同一缩写规范或该缩写词被更广泛使用,像 URL , HTML)

 

如: FileDescription

 

3、接口( Inte***ce )的命名

 

基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上,保证开头第一个字母为 ”I”, 便于与普通的 Class区别开。实在现类名称取接口名的第二个字母到最后,且满足类名的命名规范;

如: IMenuEngine

 

4、枚举( Enum )的命名

 

基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上,保证开头第一个字母为 ”E” , 便于与普通的 Class区别开。

如: EUserRole

 

5、异常( Exception )的命名

 

异常( Exception ) 通常采用字母 e 表示异常,对于自定义的异常类,其后缀必须为 Exception

如: BusinessException

 

6、方法( Method )的命名

 

方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。

 

方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头

如: getCurrentUser() 、 addUser() 、 hasAuthority()

 

7、参数( Param )的命名

 

第一个单词的首字母小写,其后单词的首字母大写。参数目名不答应以下划线或美元符号开头, 固然这在语法上是答应的。参数名应简短且富于描述。

如: public UserContext getLoginUser(String loginName);

 

8、常量字段 ( Constants )的命名

 

静态常量字段( static final ) 全部采用大写字母,单词之间用下划线分隔;

如: public static final Long FEEDBACK;

        public static Long USER_STATUS;

 

 

3、注释规范

 

 

一个很好的可遵循的有关注释的经验法则是:

 

问问你自己,你假如从未见过这段代码,要在公道的时间内有效地明白这段代码,你需要一些什么信息???

 

一般概念

 

1、注释应该增加代码的清楚度

 

2、保持注释的简洁

 

3、在写代码之前或同时写注释

 

4、注释出为什么做了一些事,而不仅仅是做了什么

 

注释哪些部分

 

1、Java 文件:必须写明版权信息以及该文件的创建时间和作者;

2、类:类的目的、即类所完成的功能,以及该类创建的时间和作者名称;多人一次编辑或修改同一个类时,应在作者名称处出现多人的名称;

3、接口: 在满足类注释的基础之上,接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的条件下对应的实现类可以不加注释;

4、方法注释: 对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索;

5、方法内部注释: 控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出具体的注释;

6、参数: 参数含义、及其它任何约束或条件条件;

7、属性: 字段描述;

8、局部 ( 中间 ) 变量: 无特别意义的情况下不加注释;

 

注释格式

 

遵循工程规定的同一注释格式,一般情况下会以 codetemplates.xml 格式的文件导进 IDE(Eclipse) 或者用Eclipse默认的;

 

4、代码格式规范

 

遵循工程规定的同一代码格式,一般情况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化;

 

5、其他规范

 

JSP 文件命名

用完整的英文描述说明 JSP 所完成的功能,尽可能包括一个生动的动词,第一个字母小写,

如: viewMessage.jsp 、editUser.jsp 等。

 

6、工程特有命名规范

 

持久层

 

1、 Hibernate 映射文件及实体与数据库表名称完全对应;

如: Advertisement.hbm.xml 、 Advertisement.java

 

2、数据访问 DAO

DAO 接口和实现类名称必须完全符合正常接口和实现类的命名规则,且最后以 ”DAO” 结尾DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操纵;

如: ICrossAdDAO( 接口 ) 、 CrossAdDAO( 实现类 )

 

3、各种操纵数据库的 HQL 配置文件

HQL 文件的个数原则上与系统的 Services 层的服务个数相等,且以服务名称命名 HQL 文件;

如: resource.hbm.xml

 

服务层

 

1、服务接口和实现

 

服务接口和实现类必须完全符合正常接口和实现类的命名规则;以工程定义的服务名为主体, 并同一以 ”Serv” 结尾

如: IResourceServ( 服务接口 ) 、 ResourceServ( 接口实现类 )

 

2、服务接口方法

 

方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。

 

方法名尽可能的描述出该方法的动作行为。

 

返回类型为 Boolean 值:用“ is ”或“ has ”来开头

 

得到某数据: get+ 数据描述名词复数 + 数据类型;

 

得到所有数据: get+All+ 数据描述名词复数 + 数据类型;

 

通过 XXX 得到 / 查询某数据: get/query+ 数据描述名词复数 + 数据类型 +By+ 条件;

 

添加某数据: save/add+ 数据描述名词 ()

 

更新某数据: save/update+ 数据描述名词;

 

删除某数据: delete/remove+ 数据描述名词;

 

3、业务对象

业务名称 +BO

 

4、查询参数对象

 

凡是继续 Abst***QuerySpec 的查询参数类全部满足以下规则:

 

Query+ 所要查询的数据描述名词 +Spec

 

作为参数传进时,参数名必须为:所要查询的数据描述名词 +Spec

如: QueryProgramSpec

 

MVC 层

 

1、Action 控制层

 

Action 类名:功能模块名称 +Action ;

 

Actoin 方法名称尽可能的描述出页面迁移的往向

 

如: LoginAction( 登录用 action) , toWelcome( 转向欢迎页的 action 方法 )

 

2、资源文件

 

系统全局资源文件: globalMessages_+ 字符编码类型 +.properties

 

功能模块内部的资源文件: package.properties

 

Spring 配置文件

 

1、Action 相关配置文件

 

文件目录: WebRoot/WEB-INF/spring/action/ 功能模块名称 +_ApplicationContext.xml

 

2、Services 相关配置文件

 

文件目录: WebRoot/WEB-INF/spring/services/Services_ApplicationContext.xml

 

3、全局性配置文件

 

文件目录: WebRoot/WEB-INF/spring/工程名+_ApplicationContext.xml

 

JSP 文件

 

采用完整的英文描述说明 JSP 所完成的功能,尽可能包括一个生动的动词,第一个字母小写,

如: viewMessage.jsp 、editUser.jsp 等。

 

分享到:
评论

相关推荐

    JAVA程序员不可不注意的编码规范

    Java 编码规范是每一位Java程序员应当遵循的重要指导原则,它不仅关乎代码的质量,也直接影响到项目的维护效率和团队协作的顺畅程度。良好的编码规范能够降低软件的维护成本,提高代码的可读性和团队间的沟通效率,...

    Java程序员应该注意的编码规范

    ### Java程序员应该注意的编码规范 #### 一、引言 在软件开发过程中,编码规范起着至关重要的作用。良好的编码规范不仅可以降低软件维护的成本,还能提升代码的可读性和可维护性,进而提高团队协作的效率。本文将...

    java程序员开发必备之java编码规范

    代码规范相当重要. 代码规范提高软件代码的可读性 , 使得开发人员快速和彻底的理解新代码. 好的代码风格不仅会提高可读性 ,而且会使代码更健壮 , 更为...本书为chm格式的,希望对大家学好java的编码规范有所帮助……

    Java程序员面试资料及简历模版

    Java程序员面试资料及简历模版 Java程序员面试资料及简历模版 Java程序员面试资料及简历模版 Java程序员面试资料及简历模版 Java程序员面试资料及简历模版 Java程序员面试资料及简历模版 Java程序员面试资料及简历...

    JAVA程序员编码规范

     编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码 。 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品 。 为了执行规范,每个软件开发...

    最新的java程序员不可不学的java基础教程

    《最新的java程序员不可不学的java基础教程》是一本针对初级Java程序员的宝贵资源,旨在强化和深化对Java编程基础的理解。在这个版本中,我们有理由相信已经解决了之前版本可能出现的打开问题,使得学习者可以无障碍...

    Java程序员面试宝典

    《Java程序员面试宝典》主要内容简介:目前许多开发者对Java语言及其底层原理掌握不牢固,在面试过程中经常漏洞百出,无法取得好成绩。而招聘单位为了得到高素质的员工往往使出浑身解数,采用各种形式的面试考察求职...

    java程序员面试交流项目经验

    java程序员面试交流项目经验java程序员面试交流项目经验java程序员面试交流项目经验java程序员面试交流项目经验java程序员面试交流项目经验java程序员面试交流项目经验java程序员面试交流项目经验java程序员面试交流...

    java程序员面试简历 WORD 模版

    Java程序员在求职过程中,一份优秀的简历是至关重要的。下面我们将详细探讨如何利用提供的"JAVA 个人简历模版"来创建一份吸引人的Java程序员简历,并理解其中包含的关键知识点。 首先,标题"java程序员面试简历 ...

    JAVA程序员简历模板(最新版)

    【JAVA程序员简历模板】 在创建一份专业的JAVA程序员简历时,首先要明确的是,这份文档将是你在求职市场上的“名片”,它应该清晰、准确地展示你的技术能力、项目经验和教育背景。以下是一个详细的模板,帮助你构建...

    java程序员转正ppt

    总结来说,Java程序员转正涉及到的技术要点包括但不限于Java基础、集合框架、文件处理、日期时间操作、Linux基础知识以及可能涉及的数据库知识。在答辩过程中,展示出扎实的技术基础、良好的学习习惯和团队合作精神...

    Java程序员面试笔试宝典-何昊pdf版

    根据提供的文件信息,我们可以推断出这是一本关于Java程序员面试和笔试准备的书籍,作者为何昊。本书可能包含了大量关于Java编程语言的基础知识、高级特性以及与面试相关的技巧和策略等内容。下面将对可能涉及的重要...

    Java程序员上班那点事儿txt版本

    - **角色**:初入职场的Java程序员,主要负责基础编码工作。 - **要求**:掌握Java基础知识,能够独立完成简单的开发任务。 - **薪资范围**:较低,通常在2000-6000元之间。 2. **中级阶段**: - **角色**:...

    java程序员简历模板(一共19套模板)

    java程序员个人简历.doc JAVA软件工程师简历范文.docx Java软件开发工程师个人简历模板.doc 个人简历(示范案例).doc 应届生Java开发个人简历.doc 非常经典java求职简历(三套-含项目介绍).doc 高级Java工程师架构师-...

    java程序员简历模板

    Java 程序员简历模板 以下是 Java 程序员简历模板的知识点总结: 一、 HR 如何刷简历 * 定位准确:个性鲜明,一眼看上去就能贴上技术精英、管理岗‘专家的标签 * 内部一致:内容聚焦,不能出现前后不符 * 简明...

    java程序员规划java程序员职业规划.docx

    Java 程序员职业规划 Java 程序员职业规划是指 Java 程序员如何规划自己的职业生涯,使自己在职业道路上更快速、更自信地发展。本文将从 Java 程序员职业规划的几个方面进行详细的介绍。 一、 认识自我 在职业...

    Java程序员上班那点事

    Java程序员上班那点事 Java程序员上班那点事 Java程序员上班那点事 Java程序员上班那点事

    java程序员的成长历程

    对于想要踏入或正在走在这条道路上的Java程序员来说,理解并经历一个完整的学习和发展过程至关重要。以下就是一篇关于“Java程序员的成长历程”的详细解读。 首先,Java初学者通常会从学习基础语法开始,包括变量、...

Global site tag (gtag.js) - Google Analytics