目录
1. 包命名规范 2
2. 类命名规范 3
一、 基本命名规范: 3
二、 注释规范 4
3. Jsp页面命名 6
ssm框架实现登录功能
项目代码编写规范
代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。
1. 包命名规范
目的:包的命名规范应当体现出项目资源良好的划分
自定义标签类所在包命名规范:com.项目名称(小写).tags
例如:web.tags
过滤器类所在包命名规范:com.项目名称(小写).web.filter
例如:web.filter
Action类所在包命名规范:com.项目名称(小写).web.action
例如:web.action
Controller类所在包命名规范:com.项目名称(小写).controller
例如:ller
Javabean所在包命名规范:com.项目名称(小写).entity
例如:ity
DAO类所在包命名规范:com.项目名称(小写).dao.impl
例如:dao.impl
DAO类所实现的接口在包中命名规范:com.项目名称(小写).dao
例如:dao
业务逻辑实现接口命名规范:com.项目名称(小写).service.impl
例如:service.impl
业务逻辑实现接口命名规范:com.项目名称(小写).service
例如:service
全局工具类所在包命名规范:com.项目名称(小写).util
例如:util
2. 类命名规范
一、 基本命名规范:
类
命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
例如:StudentInfo
例如:StudentInfo
接口命名
命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
例如:IStudentInfo
接口实现类命名
命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
例如:StudentInfoImpl
J2EE+SSM框架命名规范
l命名
命名规范:l的命名以POJO名称来制定,POJO名称l
例如:
一个POJO名称为Diary,其对应的l为l
Controller类命名
命名规范:Controller的命名以POJO名称来制定,POJO名称Controller
例如:
一个POJO名称为Diary,其对应的action为DiaryController
业务逻辑接口命名
命名规范:业务逻辑接口的命名以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){}
二、 注释规范
注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
类的注释
作用:注释整个类,简单概述该类作用。
书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,com,版权声明。
格式:
/* *
* 类功能描述:(大致描述类的功能)
* 类功能描述:(大致描述类的功能)
* @author:编写者名称
*
*
* @version: 类文件的版本号 从1.0开始(自己确定版本号的增改
* 情况), 修改情况(修改时间、作者、改动情况)
*/
类的声明语法
例如:
/**
* Title:管理员模块数据处理类
* Description: 两个数相加
* Copyright: Copyright (c) 2007
* Company:XX软件公司
*
* @author XXX
*
* @version $Revision: 1.7 $ $Date: 2016/03/01
*/
public class AdminDAO
变量、常量注释
作用:简单描述该变量的意义。
书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
格式:
/**
* 变量功能描述:(大致描述变量的功能)
*/
例如:
/**
*定义年龄变量
*/
*/
public int age;
方法注释
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论