项目开发规范..doc

项目开发规范是软件开发中的重要组成部分，它确保团队成员遵循一致的编码风格和组织结构，从而提高代码的可读性、可维护性和团队协作效率。以下是对提供的项目开发规范的详细说明： 1. **项目包结构**： - `src`: 代码源文件目录 - `com.ars.mybatis`: 项目主要的包结构，包含项目相关的子包 - `conf`: 存放配置文件，如Spring和Mybatis配置 - `common`: 公共类库，供整个项目使用 - **模块 A 和 B**: - `entity`: 实体类，对应数据库表 - `services`: 业务逻辑处理 - `dao`: 数据访问对象，处理数据层操作 - `mappers`: 数据库映射文件，Mybatis的XML配置 - `common`: 模块内的公共类 - `action`: Struts相关的控制器 - `conf`: Struts配置文件 - `webroot`: Web应用的根目录 - `common`: 公共页面 - **模块 A 和 B**的页面 - `css`, `js`, `images`: 分别存放样式表、脚本和图片资源，模块化管理 2. **命名规范**： - **Action**: 大写字母开头，多单词时每个单词首字母大写，后缀`Action`，如`UserCrudAction.java` - **DAO**: 接口以`I`开头，多单词时每个单词首字母大写，后缀`Dao`；实现类去掉`I`，如`IUserDao.java`和`UserDao.java` - **Service**: 接口类似DAO，以`I`开头，后缀`Service`；实现类去掉`I`，如`IUserService.java`和`UserService.java` - **实体Bean**: 数据库表名去掉前缀`T`，首字母大写，如`T_AA_BB_CC_DD`对应`AaBbCcDd.java` - **数据库映射**: 接口类以`I`开头，后缀`Mapper`，如`IUserMapper.java`；映射器文件去掉`I`，如`UserMapper.xml` - **自定义类**: 大写字母开头，多单词时每个单词首字母大写，如`CheckPwd.java` - **类变量**: 首字母小写，多单词时后续单词首字母大写，无下划线，私有访问控制，提供setter和getter，如`private int userName` - **常量**: 全部大写，多单词间用下划线分隔，公共、静态、final，如`public static final String USER_NAME="username"` - **方法**: 首字母小写，多单词时后续单词首字母大写，避免使用名词，如`public int checkLogin(String name, String pwd){}` 3. **注释要求**： - **类注释**: - 作用：描述类的整体功能 - 书写规范：位于类声明之前，包含类的基本作用、作者、日期、版本和版权信息 - 格式：使用多行注释，包含`@author`、`@version`等Javadoc标签，列出相关类或引用 通过遵循这些规范，开发者可以创建出结构清晰、易于理解和维护的项目。同时，良好的注释有助于团队协作，减少误解，提高代码质量。在实际开发中，还应结合具体项目需求和团队习惯进行适当的调整。