项目规范命名.pdf

智遊云项目命名规范 注：本文中标注 【规则_*】的条款必须严格执行，标注 【建议_*】的条款为提倡 采用。 1 JSP ． 页面命名规则 _1 【规则 】大小写：所有文件的首字母小写； 【规则_2】命名：根据页面的功能，一般为业务名称 + 功能；如： loginInfo_edit.jsp，其中操作对象的首字母小写； _3 【规则 】常用的操作动作： 新增：_new 编辑：_edit 查看：_view 列表：_list 详细：_info 审批：_audit 确认：_confirm 查询：_query 注：各页面命名总体如此，要求意思表达完整。 2. 包的命名（PackageNames） _1 【规则 】包名应该都用小写字母组成。 例如：dao/entity 包的命名：com.smartlab .dao实现类包含子包impl .entity实体类 .utils工具类，如时间函数，连接数据库类 .bi 业务类包含子包impl .net通信类，主要涉及终端的通信 1 .config配置文件 3. 类和接口的命名（ClassNames） _1 【规则 】类名采用第一个字母大写其他字母小写的形式。 【规则_2】由多个单词组成的类名采用单词的第一个字母大写其他小写的形式。 例如： Class UserDao JavaBean类均以类说明形式； 例如：Admin Utils类均以类说明加*+Utils形式； 例如：HibernateUtils Bi 类均以类说明加*+Bi 形式； 例如：AdminBi Dao类均以类说明加*+Dao形式； 例如：AdminDao 【规则_3】接口的声明均以I开头以相应类声明规范形式结尾， IAdminDao IAdminBi 如： 、 。 4. 变量的命名（ConstantNames） _1 【规则 】变量名应尽量使用对应英文或中文缩写，不能随便起名，影响编码人 员编程。 【规则_2】构成名称的各单词均用大写，并且各单词之间用 “_”分割。例： MAX_SIZE 程序中应该使用常量代替 “25”，“100”等实际的数字，如： //推荐 if(times==MAX_TIMES){ } //避免 if(times==25){ } 2 5. 方法的命名（MethodsNames） 【规则_1】方法名以小写字母开头，以后每个单词的第一个字母大写。 【规则_2】因为方法是在它所在的类的上下文中被调用的，所以没有必要在方法 名中重复类的名字。例如类Customer 中有一个方法可以提取顾客的名字，我们 应该把这个方法命名为getName，而不是getCustomerName。当这个类的用户要 调用此方法时，他们只需写 customer.getName()，而不用写成重复的 customer.getCustomerName()。 【规则_3】当用一个方法调用同一个类或子类里的另一个方法时，需明确地使用 “this.methodName()”来强调你正在调用自己类里的方法。 _4 【规则 】命名：根据方法的功能命名。 get*;获取数据；比如：getAllUers(); find*;检索数据；比如：findUsersByID(); load*;载入数据；比如：loadUserByID(); insert*;添加数据；比如：insertUser(); delete*;删除数据，比如：deleteUser();