基于web的多用户文件管理系统开发编码规范.doc
上传人:qw****27 上传时间:2024-09-12 格式:DOC 页数:5 大小:46KB 金币:15 举报 版权申诉
预览加载中,请您耐心等待几秒...

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

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

预览

在线预览结束,喜欢就下载吧,查找使用更方便

15 金币

下载此文档

如果您无法下载资料,请参考说明:

1、部分资料下载需要金币,请确保您的账户上有足够的金币

2、已购买过的文档,再次下载不重复扣费

3、资料包下载后请先用软件解压,在使用对应软件打开

基于web的多用户文件管理系统开发编码规范本项目的目录结构为:说明:index.jsp首页images存放公共图片css存放公共样式表js存放公共js文件download下载模块error出错控制模块user用户模块一、规范存在的意义应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因:好的编码规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;好的编码规范可以最大限度的提高团队开发的合作效率;长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;二、命名规范一般概念尽量使用完整的英文描述符采用适用于相关领域的术语采用大小写混合使名字可读尽量少用缩写,但如果用了,必须符合整个工程中的统一定义避免使用长的名字(小于15个字母为正常选择)避免使用类似的名字,或者仅仅是大小写不同的名字避免使用下划线(除静态常量等)标识符类型说明包(Package)的命名Package的名字应该采用完整的英文描述符,都是由一个小写单词组成。并且包名的前缀总是一个顶级域名,通常是com、edu、gov、mil、net、org等;Servlet类所在包命名规范:cn.edu.jxnu.sksoftware.web.servlet自定义标签类所在包命名规范:com.struts2.baseAction类所在包命名规范:com.struts2.action工具类命名规范:com.struts2.tools拦截器实现所在包命名规范:com.struts2.interceptor2.类(Class)的命名类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词,避免缩写词(除非工程内有统一缩写规范或该缩写词被更广泛使用,像URL,HTML);接口(Interface)的命名基本与Class的命名规范类似。在满足Classd命名规则的基础之上,保证开头第一个字母为“I”,便于与普通的Class区别开。其实现类名称取接口名的第二个字母到最后,且满足类名的命名规范;枚举(Enum)的命名基本与Class的命名规范类似。在满足Classd命名规则的基础之上,保证开头第一个字母为“E”,便于与普通的Class区别开;异常(Exception)的命名异常(Exception)通常采用字母e表示异常,对于自定义的异常类,其后缀必须为Exception;方法(Method)的命名方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为Boolean值的方法一般由“is”或“has”来开头;三、注释规范一个很好的可遵循的有关注释的经验法则是:问问你自己,你如果从未见过这段代码,要在合理的时间内有效地明白这段代码,你需要一些什么信息?一般概念注释应该增加代码的清晰度;保持注释的简洁;在写代码之前或同时写注释;注释出为什么做了一些事,而不仅仅是做了什么。注释哪些部分Java文件:必须写明版权信息以及该文件的创建时间和作者;类:类的目的、即类所完成的功能,以及该类创建的时间和作者名称;多人一次编辑或修改同一个类时,应在作者名称处出现多人的名称;/***类功能描述:(大致描述类的功能)*@author:编写者名称*@version:类文件的版本号从1.0开始(自己确定版本号的增改情况),*修改情况(修改时间、作者、改动情况)*@see包名.参考类名(列出父类,引入类,每个类占一行),如果有可省略*相关数据如:(便于理解本类的一些常量数据及某些数据的格式或认为比较重要的数据,如果没有可省略)*/接口:在满足类注释的基础之上,接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释;方法注释:对于设置(Set方法)与获取(Get方法)成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索;/***方法功能说明*@paramargs(参数类型可以写在参数后,也可以省略。每个参数占一行)*@return输出参数(多种情况写在同一行)*@see类#参考方法(与此方法有调用关系的方法供参考,不必每个方法都完整列出,*要选择有意义的,每个方法占一行)*@exception异常处理类(方法中能够引