程序代码简要规范.doc

程序代码简要规范

程序代码规范
程序代码规范旨在为.Net、Java、Flex等常见程序开发技术的代码提供通用的规范，约束程序代码中关键和通用的部分，以方便代码的复用和后期的维护。
包命名（命名空间）
要求：格式为：com.emapping.应用名称.……；对于第三方的代码，如果有改动，也需采用此命名。
例如：防伪项目Java包：com.emapping.antifake.……；
防伪项目Net命名空间：com.emapping.antifake.……；
防伪项目Flex包：com.emapping.antifake.……。
类、方法和变量命名
要求：使用英文单词组合进行命名，并且相邻的单词首字母大写（即驼峰命名规则）；全局变量或常量所有字母大写命名。
例如：类UserService，方法getUserInfo()，全局变量或常量COUNT。
注意：1，不能使用中文汉字命名；
2，不能使用汉语拼音命名；
3，要使用有实际意义的英文单词。
页面(Jsp|Asp.net)、样式和脚本命名
要求：使用英文单词组合进行命名，并且全部小写。
样式和脚本一般要求保存在单独的目录中，并且目录和文件名称全为小写英文。
例如：user\edit.jsp
user\js\user.js
代码冗余
必须去掉所有未使用的注释掉的代码，以及页面中未使用的Javascript代码、样式代码、html元素。
代码复用原则
在代码中避免重复的代码，需将重复的代码重构成可复用的函数。
当一个复杂函数中代码量超过了100行时，需拆分成多个可复用的函数，每个函数的代码量控制在100行以内。
当一个复杂类中代码量超过了2000行时，需拆分成多个类，每个类的代码量控制在2000行以内。
分层与命名(参考)
本部分可参考使用，代码中有此层需依此命名，无此层可自行命名，但包命名（命名空间）不可变化；对于接口类和实现类命名格式，.net和flex可依据通用命名习惯，不依此要求。
控制层命名：
格式：com.emapping.应用名称.action.模块名
例如：com.emapping.antifake.action.UserAction
业务层命名：
接口格式：com.emapping.应用名称.service.模块名
例如：com.emapping.antifake.service.UserService
实现类格式：com.emapping.应用名称.service.impl.模块名
例如：com.emapping.antifake.service.impl.UserServiceImpl
持久层命名：
接口格式：com.emapping.应用名称.dao.模块名
例如：com.emapping.antifake.dao.UserDAO
实现类格式：com.emapping.应用名称.service.impl.模块名
例如：com.emapping.antifake.dao.impl.UserDAOImpl
持久化对象命名：
格式：com.emapping.应用名称.model.实体对象名
例如：com.emapping.antifake.model.UserInfo
代理层命名：
格式：com.emapping.应用名称.delegate.模块名
例如：com.emapping.antifake.delegate.UserDelegate
一般情况下不要求使用代理层，但是如果使用第三方的组件是，不能在代码中直接调用第三方的组件包，必须使用专门的代理类进行包装。
注释：
所有类、接口、非私有方法必须详细注释；
关键算法中使用的变量必须详细注释，最好包含调用的demo；
代码更新时，注释必须同时更新，更新内容包括修改人员、修改时间、修改内容。当方法（或类）修改的量达到40％时，必需重构；
注释的量要求达到20%以上；
尽量使用中文注释，除非此处用英文可以精准的表达意思。
异常：
所有异常不能抛弃；
所有异常需记录日志，不能在控制台输出；
充分利用finally释放占用资源；
所有自定异常需继承自com.emapping.common.exception.GeneralFailureException
数据有效性：
验证网页数据有效性，需先在前台脚本中验证，然后在服务器上进行后台验证；
测试：
单元测试要求达到语句覆盖。
单元测试要跟踪每一条语句，并观察数据流与变量的变化。
功能类都应该使用JUnit进行单元测试。

JavaScript脚本和样式规范
总则
文件命名
JavaScript文件命名规则为:英文小写目录+英文小写文件名称＋.js
样式文件命名规则为:英文小写目录＋英文小写文件名称＋.css
例如：js/filena