QQ模拟聊天软件程序设计(编码).docVIP

项目编号 NO.1 文档编号 NO.4 密 级 内部 QQ模拟聊天 文档名称： QQ模拟聊天软件程序设计（编码） 项目名称： QQ模拟聊天软件 项目负责人： XX 评 审 日 期： 2012年12月5日 目 录 1、前言 1. 背景 3 2. 规范实施建议 3 3. 定义和约定 3 2、格式规范 3 1. 缩进 3 2. 行长度 3 3. 声明 4 a) 声明变量、常量 4 b) 声明类 4 4. 语句 4 3、命名规范 5 1. 通用规则 5 2. 项目规则 5 3. 附加说明 6 4、组织规范 6 1. web工程目录规范 6 2. 引入包规范 6 5、注释规范 6 1. 通用注释规则 6 a) 说明 6 b)javadoc注释标签语法定义说明 6 2. 类的注释 7 3. 方法的注释 7 4. 失效代码块的注释 7 5. 分支语句的注释 8 6. 变量、常量的注释 8 6、异常处理规范 9 7、补充规范 9 前言 背景 在项目开发维护中，编码规范作为开发规范的一个组成部分，是十分重要和必须的，它不仅仅是为了提高开发效率，也有利于降低后期维护开发的成本。编码规范的根本目的就是要让不仅代码可以一目了然，也可以很容易的理解开发人员所编写的代码程的用途和意义。由此，用来减少项目中因为开发维护人员的更替或由于长时间不维护造成的记忆模糊或混乱等情况带来的对代码所实现的真正功能的理解困难和歧义。另外也提高了代码复查效率和效果。 规范实施建议 不是为了规范而规范，以提高软件开发质量和效率为目标，逐步改进编码规范化水平 对于格式规范、注释规范等部分规范的要求，java代码可以通过使用eclipse自带的Format方法（快捷键：Ctrl+Shift+F）进行自动格式化，可以提高开发效率又符合编码规范。 定义和约定 第1个字符大写，其后每个单词的第1个字母大写 第1个字符小写，其后每个单词的第1个字母大写 格式规范 缩进 使用Tab键缩进； 不允许使用空格键进行缩进。 行长度 .java文件：每行不超过120字符； .properties:不折行 声明 声明变量、常量 一行只声明一个变量或常量； 在代码块的开始处声明变量，不要在首次用到该变量时才声明 声明类 左大括号{位于声明语句同行的末尾，右大括号}另起一行； 方法与方法之间以一个空行分隔 语句 if语句总是用{和}括起来 示例 class Example { void bar() { do { } while (true); try { } catch (Exception e) { } finally { } } void foo2() { if (true) { return; } if (true) { return; } else if (false) { return; } else { return; } } } 命名规范 通用规则 标识符类型 命名规则 示例 工程（project） 整个工程采用UTF-8编码 SchoolManagerService 包(Packages) 包名命名全部小写字母； 源代码使用com.t53.项目名缩写开头的包名； 使用单个单词 com.t53.entity/servlet/dao/idao 类(Class) 实体类(entity) 首字母大写，单词间首字母大写。 如用户类为：Users 接口(Interfaces) 所有接口以I开头。首 字母大写，单词间首字母大写。 如用户类的dao类的接口为：IUsers Dao类 所有dao类以实体类名+dao命名。首字母大写，单词间首字母大写。 如用户类的dao类为：UsersDao 业务逻辑类（servlet） 所有servlet类以用途+servlet命名 如添加用户业务逻辑类为：UserAddServlet 方法(Methods) 方法名是一个动词【推荐】 runMethod(); 常量(Constants) 常量命名全部大写，单词间用下划线隔开； 常量必须是静态、final类型 public static final String INVITATION_TYPE_GENERAL= general; 项目规则 JAVA代码 对象变量的定义初始值必须为null， 使用装箱的数据类型：Integer，String等。 页面 必须限制输入字符的最大长度。