- 浏览: 347959 次
- 性别:
- 来自: 北京
文章分类
最新评论
-
pacoson:
感谢楼主。请受小生一拜。
ANT预编译JSP -
zhuhongming123:
一楼的同学Lucene4.* 以上的 已经改成了Numeric ...
Lucene日期排序及组合查询 -
ywjk520:
RangeQuery在哪个包里?
Lucene日期排序及组合查询 -
willwen:
有个疑问,楼主,为何初始化bits 从txt读取已有的网址是直 ...
布隆过滤器(Bloom Filter)之java实例 -
yu_226528:
还不如没有呢
jFreeChart 在jsp页上实现简单的折线图、柱状图
一、规范存在的意义
应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因:
1、好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;
2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;
3、好的编码规范可以最大限度的提高团队开发的合作效率;
4、长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;
二、命名规范
1、一般概念
1、尽量使用完整的英文描述符
2、采用适用于相关领域的术语
3、采用大小写混合使名字可读
4、尽量少用缩写,但如果用了,必须符合整个工程中的统一定义
5、避免使用长的名字(小于 15 个字母为正常选择)
6、避免使用类似的名字,或者仅仅是大小写不同的名字
7、避免使用下划线(除静态常量等)
2、标识符类型说明
1、包( Package )的命名
Package 的名字应该采用完整的英文描述符,都是由一个小写单词组成。并且包名的前缀总是一个顶级域名,通常是com,edu,gov ,mil ,net ,org 等<如:com.yjhmily.test>
2、类( Class )的命名
类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词,避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用,像 URL , HTML)<如: FileDescription>
3、接口( Interface )的命名
基本与 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;>
三、注释规范
一个很好的可遵循的有关注释的经验法则是:
问问你自己,你如果从未见过这段代码,要在合理的时间内有效地明白这段代码,你需要一些什么信息???
1、一般概念
1、注释应该增加代码的清晰度
2、保持注释的简洁
3、在写代码之前或同时写注释
4、注释出为什么做了一些事,而不仅仅是做了什么
2、注释哪些部分
1、Java 文件:必须写明版权信息以及该文件的创建时间和作者;
2、类:类的目的、即类所完成的功能,以及该类创建的时间和作者名称;多人一次编辑或修改同一个类时,应在作者名称处出 现多人的名称;
3、接口: 在满足类注释的基础之上,接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释;
4、方法注释: 对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通 成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读 提供宝贵线索;
5、方法内部注释: 控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出 详细的注释;
6、参数: 参数含义、及其它任何约束或前提条件;
7、属性: 字段描述;
8、局部 ( 中间 ) 变量: 无特别意义的情况下不加注释;
3、注释格式
遵循工程规定的统一注释格式,一般情况下会以 codetemplates.xml 格式的文件导入 IDE(Eclipse) 或者用Eclipse默认的;
四、代码格式规范
遵循工程规定的统一代码格式,一般情况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化;
五、其他规范
JSP 文件命名
采用完整的英文描述说明 JSP 所完成的功能,尽可能包括一个生动的动词,第一个字母小写,如: viewMessage.jsp 、 editUser.jsp 等。
六、工程特有命名规范
1、持久层
1、 Hibernate 映射文件及实体
与数据库表名称完全对应;
如: Advertisement.hbm.xml 、 Advertisement.java
2、数据访问 DAO
DAO 接口和实现类名称必须完全符合正常接口和实现类的命名规则,且最后以 ”DAO” 结尾
DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操作;
如: ICrossAdDAO( 接口 ) 、 CrossAdDAO( 实现类 )
3、各种操作数据库的 HQL 配置文件
HQL 文件的个数原则上与系统的 Services 层的服务个数相等,且以服务名称命名 HQL 文件;
如: resource.hbm.xml
2、服务层
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;
3、MVC 层
1、Action 控制层
Action 类名:功能模块名称 +Action ;
Actoin 方法名称尽可能的描述出页面迁移的去向
如: LoginAction( 登录用 action) , toWelcome( 转向欢迎页的 action 方法 )
2、资源文件
系统全局资源文件: globalMessages_+ 字符编码类型 +.properties
功能模块内部的资源文件: package.properties
4、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
5、JSP 文件
采用完整的英文描述说明 JSP 所完成的功能,尽可能包括一个生动的动词,第一个字母小写,如: viewMessage.jsp、editUser.jsp 等。
发表评论
-
java用绑定变量调用Oracle
2011-03-11 16:59 1085在JAVA中的SQL 语句的编 ... -
java 实现压缩与解压缩ZIP
2010-08-18 10:17 852压缩的 import java.io.BufferedIn ... -
Java中对TreeMap中文排序
2010-08-17 18:20 1889package org.hsyd.test; ... -
java 卸载动态链接库
2010-06-21 11:53 1915import java.lang.reflect.Field; ... -
java数据库连接池实现
2010-02-05 11:21 768.package cc.vicp.eden.plug; ... -
Java NIO原理和使用
2010-01-16 14:29 1647Java NIO非堵塞应用通常适用用在I/O读写等方面,我们知 ... -
java排序全实现
2009-12-17 11:40 9301. package sort; 2. ... -
Java对各种文件的操作
2009-12-12 22:23 989java中提供了io类库,可以轻松的用java实现对文件的各种 ... -
直接由Java获取文件的创建时间
2009-11-11 11:22 3028import java.io.*; public cla ... -
非常实用的myeclipse快捷键
2009-08-13 22:24 1205技巧:取消自动validation validation有一堆 ... -
计算工作日和自然日
2009-06-24 19:21 3333用Java写一个倒计时程序,比如输入一个日期,格式为20090 ... -
文件排序后进行文本复制
2009-06-24 18:48 990现将TEXT1.TXT中的文本内容 复制到TEXT2.TXT中 ... -
getResourceAsStream的用法
2009-06-24 18:28 2593getResourceAsStream 用法大致有以下几种: ... -
将一首古诗竖着排序从右往左读
2009-06-24 17:36 3138import java.util.ArrayList; ... -
计算两个日期之间相差的天数
2009-06-24 16:47 2021程序经过一系列处理,得到两个string类型的时间值,一个值的 ... -
如何得到一年的所有星期二的日期?
2009-06-24 16:42 1445import java.text.DateFormat; ... -
根据格式日期转换
2009-06-24 16:39 910根据一个TimeZone的时间,比如一个“Africa/Acc ... -
当输入一个年月份的时候,输出这个月份的最后一天,比如输入: 2006年5月 就输出5月份的最后一个日
2009-06-24 16:00 1166import java.text.ParseException ... -
读取一个文本文档,例如有1~10行,要求按10~1行的顺序输出.并保存予原文件.
2009-06-24 15:49 1353import java.io.File; import ... -
编写一个辅助小学生学习乘法的程序
2009-06-22 16:39 1625编写一个辅助小学生学习乘法的程序。使用一个Random对象产生 ...
相关推荐
Java编码规则.pdf Java编码规则.pdf是AmbySoft Inc.公司发布的一份白皮书,旨在提供一套详细的编码规范、惯例和指南,以帮助Java开发者编写高质量的代码。该白皮书的目的是让Java开发者能够编写易于理解、维护和...
这份"JAVA编码规则(英文版)"是一个经典的指南,它涵盖了多个关键知识点,旨在帮助程序员编写出更优的代码。 1. **命名规范**: - 类名应使用大驼峰命名法,每个单词首字母大写,例如`ClassName`。 - 变量名和...
Java编码规则是编程实践中至关重要的指导原则,它们旨在提高代码的可读性、可维护性和团队协作效率。这本书深入探讨了如何遵循最佳实践来编写高质量的Java代码。虽然描述中提到的是英文版,但我们可以从中提炼出一些...
Java 编码规范是指在 Java 语言中编写代码时需要遵守的一些约定和规则,以确保代码的可读性、可维护性和可扩展性。本文将对 Java 编码规范的主要内容进行详细讲解。 命名风格是 Java 编码规范的重要组成部分。Java ...
华为JAVA编码规范.pdf 华为JAVA编码规范.pdf是华为公司编写的JAVA编程语言编码规范,旨在提供一个统一的编程风格和代码组织方式,以提高代码的可读性、维护性和可重用性。该规范涵盖了编程语言的基本结构、命名规则...
腾讯 Java 编码规范 腾讯 Java 编码规范是腾讯集团管理标准的一部分,旨在确保公司项目代码的易维护性和编码安全性。该规范涵盖了 Java 编码风格、文件组织、代码风格、注释、命名、声明、异常、习惯等方面。 一、...
Java编码是程序开发的核心环节,主要涉及Java语言的语法、编程规范、最佳实践以及相关工具的使用。在Java编程中,我们遵循一定的规则和标准,以确保代码的可读性、可维护性和高效性。以下是对Java编码相关知识点的...
1. **命名规则**:Java编码标准规定了变量、类、接口和方法的命名应该遵循的规则。类名应使用驼峰式命名,每个单词首字母大写(如:ClassName)。接口名同样遵循驼峰式,但通常使用全大写字母(如:InterfaceName)...
以下是从给定的文件信息中提炼出的关键知识点,涵盖了JAVA编码规范的基本原则、文件管理、代码格式、变量命名规则、以及代码注释等方面。 ### 一、JAVA编码规范的重要性 JAVA编码规范的目的在于统一代码的编码风格...
1. **读取Tag**:从字节数组的起始位置读取Tag的字节,根据编码规则解析出Tag值。 2. **读取Length**:根据Tag的编码方式,解析Length字段,确定Value的字节长度。 3. **读取Value**:从字节数组中取出Length指定...
编码是用来表示字符的规则,例如ASCII、GBK、UTF-8等。GBK是中国大陆广泛使用的汉字编码标准,它兼容GB2312并增加了更多的汉字和符号。UTF-8则是一种可变长度的Unicode编码,能表示世界上几乎所有的字符。 在Java中...
Java编码规范是软件开发中非常重要的一个环节,它旨在提高代码质量、可读性、可维护性和团队协作效率。这份文档,"Java编码规范.doc",由东软集团有限公司的商用软件事业部编写,包含了国内大型Java项目和国际知名...
1. **命名约定**:Java编码规范对变量、方法、类和包的命名有明确的要求。例如,类名应采用驼峰式命名法,每个单词首字母大写;方法名和变量名则使用小驼峰式,首个单词全小写;常量全大写,单词间用下划线分隔。包...
华为编码规范JAVA是华为公司为Java开发者制定的一套详细且实用的编程指导原则,旨在提升团队协作效率,降低代码维护成本,提高软件质量。 1. **命名规范**:这是编码规范的基础,包括类名、方法名、变量名等应遵循...
**百度Java编码规范** 在软件开发中,遵循一定的编码规范是非常重要的,它能提高代码的可读性,便于团队协作,降低维护成本。百度作为一家技术驱动的公司,也提出了其内部使用的Java编码规范,旨在确保代码的一致性...
Sun Microsystems(现为Oracle)制定的Java编码规范是一份广为接受的指南,它涵盖了命名规则、代码布局、注释实践以及异常处理等多个方面。以下是对这份编码规范的详细解读: 1. **命名规则**:Java的命名规则强调...
本文将深入探讨“js解码”和“java编码”这两个主题,并结合标签“源码”和“工具”,讨论如何在实际项目中应用它们。 首先,我们来看JavaScript中的解码。JavaScript是一种在客户端和服务器端都能运行的脚本语言,...
本文将深入探讨Java编码规范的一些关键原则,包括注释的标准格式和使用。 1. 类注释行 类注释是每个类定义前的必要组成部分,它提供了关于类功能、责任和作者的信息。类注释通常采用如下的模板: ```java /*******...