网站后台管理命名规范详解:JSP页面、包名、类接口变量与方法
需积分: 35 190 浏览量
更新于2024-09-18
1
收藏 42KB DOC 举报
《网站后台管理系统命名规范》是一份详细的指导文档,旨在确保项目中各个组件的命名一致性与可读性。该规范主要涵盖五个关键方面:JSP页面命名、包的命名、类和接口命名、变量命名以及方法命名。
1. JSP页面命名:
- 规则-1:所有文件的首字母小写,如`loginInfo_edit.jsp`,表示页面功能是登录信息的编辑。
- 常见操作动词:在页面名称中使用特定后缀来表示操作,如`new`(新增)、`edit`(编辑)、`view`(查看)等,使页面功能一目了然。
2. 包的命名:
- 包名全部小写,结构清晰,例如`net.zzvc.szmt.aug`,其中`.dao`代表数据访问层,`.entity`表示实体类,`.common`用于存放公共类,`.biz`表示业务逻辑层,`.web`包括Action和Form类,`.config`存放配置文件。
3. 类和接口命名:
- 类名采用驼峰命名法,如`ClassUserDao`,表明该类是用户数据访问的DAO类。
- 特殊命名约定:Action类后缀为`-Action`,Form类为`-Form`,Biz类为`-Biz`,Dao类为`-Dao`。接口名称遵循同样规则,如`IAdminDao`和`IAdminBiz`。
4. 变量命名:
- 避免随意命名,使用英文或中文缩写,如`MAX_SIZE`,强调其作为常量的用途。
- 常量命名采用全大写,单词间用下划线分隔,如`MAX_TIMES`,以提高代码的可理解性。
5. 方法命名:
- 方法名采用驼峰命名法,每个单词首字母大写,例如`getUserData()`,明确表示获取用户数据的方法。
遵循这些命名规范有助于团队成员之间更好地理解和协作,减少误解,提高代码的可维护性和可扩展性。通过统一的命名规则,可以提升项目的整体组织性和专业性,使得代码更加清晰、整洁。
2011-11-04 上传
2017-12-12 上传
2013-03-22 上传
2023-07-27 上传
2023-10-17 上传
2023-02-27 上传
2023-04-04 上传
東刀人
- 粉丝: 23
- 资源: 2
最新资源
- BottleJS快速入门:演示JavaScript依赖注入优势
- vConsole插件使用教程:输出与复制日志文件
- Node.js v12.7.0版本发布 - 适合高性能Web服务器与网络应用
- Android中实现图片的双指和双击缩放功能
- Anum Pinki英语至乌尔都语开源词典:23000词汇会话
- 三菱电机SLIMDIP智能功率模块在变频洗衣机的应用分析
- 用JavaScript实现的剪刀石头布游戏指南
- Node.js v12.22.1版发布 - 跨平台JavaScript环境新选择
- Infix修复发布:探索新的中缀处理方式
- 罕见疾病酶替代疗法药物非临床研究指导原则报告
- Node.js v10.20.0 版本发布,性能卓越的服务器端JavaScript
- hap-java-client:Java实现的HAP客户端库解析
- Shreyas Satish的GitHub博客自动化静态站点技术解析
- vtomole个人博客网站建设与维护经验分享
- MEAN.JS全栈解决方案:打造MongoDB、Express、AngularJS和Node.js应用
- 东南大学网络空间安全学院复试代码解析