基于web的多用户文件管理系统开发编码规范.doc

《基于web的多用户文件管理系统开发编码规范.doc》由会员分享，可在线阅读，更多相关《基于web的多用户文件管理系统开发编码规范.doc（5页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、基于web的多用户文件管理系统开发编码规范本项目的目录结构为：说明：index.jsp 首页images 存放公共图片css 存放公共样式表js 存放公共js文件download 下载模块error 出错控制模块user 用户模块一、规范存在的意义应用编码规范对于软件本身和软件开发人员而言尤为重要，有以下几个原因：l 好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；l 好的编码规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码；l 好的编码规范可以最大限度的提高团队开发的合作效率；l 长期的规范性编码还可

2、以让开发人员养成好的编码习惯，甚至锻炼出更加严谨的思维；二、命名规范1、 一般概念l 尽量使用完整的英文描述符l 采用适用于相关领域的术语l 采用大小写混合使名字可读l 尽量少用缩写，但如果用了，必须符合整个工程中的统一定义l 避免使用长的名字（小于 15 个字母为正常选择）l 避免使用类似的名字，或者仅仅是大小写不同的名字l 避免使用下划线（除静态常量等）标识符类型说明1、 包（ Package ）的命名Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名，通常是 com、edu、gov、mil、net、org 等；l Servlet类所在包

3、命名规范：cn.edu.jxnu.sksoftware.web.servletl 自定义标签类所在包命名规范：com.struts2.basel Action类所在包命名规范：com.struts2.actionl 工具类命名规范：com.struts2.toolsl 拦截器实现所在包命名规范：com.struts2.interceptor2类（ Class ）的命名类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用，像 URL ， HTML)；2、 接口（ Interface

4、 ）的命名基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 “I”，便于与普通的 Class区别开。其实现类名称取接口名的第二个字母到最后，且满足类名的命名规范；3、 枚举（ Enum ）的命名基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 “E” ，便于与普通的 Class区别开；4、 异常（ Exception ）的命名异常（ Exception ） 通常采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception；5、 方法（ Method ）的命名方法名是一个动词，采用

5、大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头；三、注释规范一个很好的可遵循的有关注释的经验法则是：问问你自己，你如果从未见过这段代码，要在合理的时间内有效地明白这段代码，你需要一些什么信息？1、 一般概念l 注释应该增加代码的清晰度；l 保持注释的简洁；l 在写代码之前或同时写注释；l 注释出为什么做了一些事，而不仅仅是做了什么。2、 注释哪些部分1、 Java文件：必须写明版权信息以及该文件的创建时间和作者；2、 类：类的目的、即类所完成的功能，以及该类创建的

6、时间和作者名称；多人一次编辑或修改同一个类时，应在作者名称处出现多人的名称；/* 类功能描述：（大致描述类的功能） * author：编写者名称* version： 类文件的版本号 从1.0开始（自己确定版本号的增改情况），* 修改情况（修改时间、作者、改动情况）* see 包名.参考类名 （列出父类，引入类，每个类占一行），如果有可省略 * 相关数据如：（便于理解本类的一些常量数据及某些数据的格式或认为比较重要的数据，如果没有可省略） */接口： 在满足类注释的基础之上，接口注释应该包含设置接口的目3、 的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释；4、

7、 方法注释： 对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提供宝贵线索；/* * 方法功能说明 * param args (参数类型可以写在参数后，也可以省略。每个参数占一行) * return 输出参数（多种情况写在同一行） * see 类#参考方法 （与此方法有调用关系的方法供参考，不必每个方法都完整列出， * 要选择有意义的，每个方法占一行） * exception 异常处理类（方法中能够引发的异常，每个异常占

8、一行） */5、 方法内部注释： 控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出详细的注释；6、 参数： 参数含义、及其它任何约束或前提条件；7、 属性： 字段描述；8、 局部 ( 中间 ) 变量： 无特别意义的情况下不加注释。/*定义年龄变量*/public int age;四、代码格式规范遵循工程规定的统一代码格式，一般情况下直接使用 MyEclipse 自带的默认代码格式对代码进行格式化。五、Jsp页面命名命名规范：jsp页面名称要以小写字母开头，如果有多个单词组成，用下划线连接。名称要体现出该页面的意义，最好能够与模块名称联系在一起。例如

9、：login.jsp-登录页面register.jsp-注册页面六、J2EE项目工程文件夹组织规范目的：规范开发人员web应用程序的资源组织形式，形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。根据myeclipse工具的特征，项目的目录结构为：WebRoot|-images -存放web程序所需的公共图片|-css -存放web程序所需的公共样式表|-js -存放web程序所需的公共js文件|-jsp、html页面|-commons -存放web程序所需的公共文件|-功能模块文件夹(存放与某个功能模块相关的资源)|-js -存放与该模块相关的js文件|-jsp、html页面|-WEB-INF|-classes|-lib|-tld文件