西安剑锋网络-代码编写规范
代码编写规范使用范围:J2EE项目开发。
包命名规范:
目的:包的命名规范应当体现出项目资源良好的划分
servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet
例如:net.linkcn.web.servlet
自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags
例如:net.linkcn.web.tags
过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter
例如:net.linkcn.web.filter
Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action
例如:net.linkcn.web.struts.action
ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form
例如:net.linkcn.web.struts.form
Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl
例如:net.linkcn.web.service.impl
Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service
例如:net.linkcn.web.service
DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl
例如:net.linkcn.dao.impl
DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao
例如:net.linkcn.dao
POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm
例如:net.linkcn.dao.hbm
全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global
例如:net.linkcn.global
全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util
例如:net.linkcn.util
类命名规范
基本命名规范:
类、接口命名
命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
例如:StudentInfo
接口命名
命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
例如:IStudentInfo
接口实现类命名:
命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
例如:StudentInfoImpl
J2EE+SSH框架命名规范
servlet类命名:
命名规范:以Servlet单词结尾
例如:LoginServlet
POJO命名:
使用hibernate自动生成的类即可
DAO类命名:
使用hibernate自动生成的类即可
Action类命名:
命名规范:Action的命名以POJO名称来制定,POJO名称Action
例如:
一个POJO名称为Diary,其对应的action为DiaryAction
ActionForm类命名:
命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form
例如:
一个POJO名称为Diary,其对应的actioForm为DiaryForm
业务逻辑接口命名:
命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
例如:
一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService
业务逻辑实现类命名:
命名规范:业务逻辑接口实现类的命名以POJO名称来制定
例如:
一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl
类变量命名:
命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
例如:private int studentAge;
public int getStudentAge()
{
return studentAge;
}
public void setStudentAge(int studentAge)
{
this.studentAge=studentAge;
}
常量命名:
命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
例如:public static final String USER_NAME=”userName“;
方法命名
命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。
例如:public int checkLogin(String name,String pwd){}
注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
类的注释:
作用:注释整个类,简单概述该类作用。
书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,公司名称,版权声明。
格式:
/* *
* 类功能描述:(大致描述类的功能)
* @author:编写者名称
*
* @version: 类文件的版本号 从1.0开始(自己确定版本号的增改
* 情况), 修改情况(修改时间、作者、改动情况)
*
* @see 包名.参考类名 (列出父类,引入类,每个类占一行),如果有
* 可省略
* 相关数据如:(便于理解本类的一些常量数据及某些数据的格式
* 或认为比较重要的数据,如果没有可省略)
*/
相关文章:
-
蒲城,我的故乡,西安蟠龙网络科技有限公司蒲城分公司为蒲城的互联网发展贡献自己的一份力量!为蒲城的中小企业发展提供一份性价比高的网络营销策划方案!...
-
智能手机和平板电脑的普及,产生了越来越多的移动端客户流量,尽管基于手机和平板电脑的网络浏览器种类繁多,功能也都越来越完善,但限于较小的终端屏幕以及网络流量的问题,移动设备...
-
Wordpress作为一款可在Windows与Linux环境下运行的PHP内容管理系统软件,因其功能强大、插件丰富易于扩展、主题模板不计其数而成为目前世界上使用最为广泛的博客系统。许多个人与企业都会选择...
-
怎样才能让你的网站脱颖而出呢?在网络信息的虚拟世界里,互联网提供了天下大同的机会,同时也让这个虚拟世界充斥着数不清的商业站点、垃圾站点,大多数站点缺乏灵魂、主旨,松散、...
-
在SEO优化中,很多站长都会有一个问题,就是关于网站地图。那么,在网站建设中,网站地图有什么用呢?而它对排名又有什么影响呢?西安网站建设推荐阅读 西安网站建设:企业网站怎么体...
-
在互联网精致那个如此激烈的今天,很多企业都有了自己的网站。因此,不少企业为了提高自己的竞争优势,对网站的用户体验进行完善。那么,要注意哪些地方才能增强用户体验呢? 第一,...
-
百度竞价推广关键词分组是竞价单元的知识点,但是西安剑锋网络认为是什么知识点并不重要,重要的是我们是否将这些关键词展示到想要的排名,并且减少点击费用。 对于竞价推广关键词从...
-
对于绝大多数地方网站来说,最容易赚钱的时代已经过去了,去年成为了一个最明显的分水岭。营收的难以图片,表面上是行业形势的巨变,但在这些表象背后,站长们更多的把责任推给下滑...
-
良好的用户体验,不但能够得到搜索引擎的喜欢,还能给网站带来一大批的死忠粉。这样看来,用户体验在网站建设中有着十分重要的作用。那么,怎么去提高用户体验度呢? 1、布局简单大气...
-
竞价推广设置账户啊、建立单元计划、关键词选择等都会设计到核心关键词的挖掘。下面,剑锋网络来说说,竞价推广挖掘核心关键词要注意什么。西安网站建设推荐阅读 西安竞价托管...