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

（与标 题 快递公司问题件快递公司问题件货款处理关于圆的周长面积重点题型关于解方程组的题及答案关于南海问题 内容相符） 项目编号 NO.1 文档编号 NO.4 密 级 内部 QQ模拟聊天软件程序 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 （编码） 版本：V1.0 文档名称： QQ模拟聊天软件程序设计（编码） 项目名称： QQ模拟聊天软件 项目负责人： XX 评 审 日 期： 2012年12月5日 目 录 1、前言 3 1. 背景 3 2. 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 实施建议 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. 方法 快递客服问题件处理详细方法山木方法pdf计算方法pdf华与华方法下载八字理论方法下载 的注释 7 4. 失效代码块的注释 7 5. 分支语句的注释 8 6. 变量、常量的注释 8 6、异常处理规范 9 7、补充规范 9 1、 前言 1. 背景 在项目开发维护中，编码规范作为开发规范的一个组成部分，是十分重要和必须的，它不仅仅是为了提高开发效率，也有利于降低后期维护开发的成本。编码规范的根本目的就是要让不仅代码可以一目了然，也可以很容易的理解开发人员所编写的代码程的用途和意义。由此，用来减少项目中因为开发维护人员的更替或由于长时间不维护造成的记忆模糊或混乱等情况带来的对代码所实现的真正功能的理解困难和歧义。另外也提高了代码复查效率和效果。 2. 规范实施建议 · 不是为了规范而规范，以提高软件开发质量和效率为目标，逐步改进编码规范化水平 · 对于格式规范、注释规范等部分规范的要求，java代码可以通过使用eclipse自带的Format方法（快捷键：Ctrl+Shift+F）进行自动格式化，可以提高开发效率又符合编码规范。 3. 定义和约定 · 第1个字符大写，其后每个单词的第1个字母大写 · 第1个字符小写，其后每个单词的第1个字母大写 2、 格式规范 1. 缩进 · 使用Tab键缩进； 不允许使用空格键进行缩进。 2. 行长度 .java文件：每行不超过120字符； .properties:不折行 3. 声明 a) 声明变量、常量 一行只声明一个变量或常量； 在代码块的开始处声明变量，不要在首次用到该变量时才声明 b) 声明类 左大括号"{"位于声明语句同行的末尾，右大括号"}"另起一行； 方法与方法之间以一个空行分隔 4. 语句 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; } } } 3、 命名规范 (1) 通用规则 标识符类型 命名规则 示例 工程（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"; (2) 项目规则 · JAVA代码 · 对象变量的定义初始值必须为null， · 使用装箱的数据类型：Integer，String等。 · 页面 · 必须限制输入字符的最大长度。 · 输入域可以显示的数据长度应该和可输入长度一致以length限制。 · 打印需要考虑数据过长，折行和空间不够的问题。 · 每种事件的处理最好定义自己的处理函数，不要统一到一个函数上去。降低程序的复杂度。 · 不能拷贝公共代码，只能引用。保证公共代码的唯一版本。 · 国际化资源文件 避免内容相同key值不同的资源存在 · 业务错误信息以error开头。如：errorusernull · 实体的显示字段由其实体名+属性名定义。如： userName ; · 页面提示信息以label.开头。如：labelwelcome= 欢迎登陆系统 · 菜单以menu开头。如：menuuserManagement · 按钮以button开头。如：buttonsubmit = 提交 (3) 附加说明 1、 从命名中可以直观看懂其定义和用途，否则必须增加注释说明； 2、 在同一系统内命名必须保持统一；避免出现类似示例中的情况； 示例：项目组id 变量定义：pgid、projectgroupId、idprojectgroup、idProjGroup 3、 避免名字过长、命名采用英文缩写，避免使用汉语拼音【推荐】 4、 组织规范 引入包规范 不允许引入类中未使用的包； 引入包时不能直接引入“.*”，必须明确到引入的类名 5、 注释规范 1. 通用注释规则 a) 说明 注释要精简并清晰容易理解； 保持注释与代码同步。 代码质量不好但能正常运行，或者还没有实现的代码用 //TODO:任务 ； 存在错误隐患的代码用 //FIXME:声明； 对于不建议使用的类或者方法，必须在他们的注释中增加 @deprecated b) 注释标签语法定义说明 @author 对类的说明 标明开发该类模块的作者 @version 对类的说明 标明该类模块的版本 @see 对类、属性、方法的说明 参考转向，也就是相关主题 @param 对方法的说明 对方法中某参数的说明 @return 对方法的说明 对方法返回值的说明 @exception 对方法的说明 对方法可能抛出的异常进行说 @deprecated 对类或方法的说明 该类或方法不建议使用 2. 类的注释 目的：简单概述该类作用 范围：所有java类，可以不包括javabean 书 关于书的成语关于读书的排比句社区图书漂流公约怎么写关于读书的小报汉书pdf 写规范：类的注释必须写在该类的声明语法之前。在注释中要描述该类的描述，创建者，创建日期。 3. 方法的注释 目的：简要概述该方法的功能，包括其参数、返回值意义的注释 范围：java类中的各种方法 注：接口的实现方法的注释应写在接口中而不是实现代码中； 对自动生成的get/set方法要添加注释； 模板：对于已定义好的接口的方法，可以直接输入 /**回车 eclipse可自动生成注释模板 示例： /** * 演示方法注释 * @param args * @return * 返回 null 表示没有找到 * @throws Exception */ private String[] demoFunction(String args) throws Exception{ return null; } 4. 失效代码块的注释 目的：对一块暂时不启用的代码进行注释。 注：这里并不是指垃圾、无用的代码，只是暂时不启用或暂时不明确的代码 书写规范：失效代码块采用块注释方法行注释方法进行标注。 示例： // if (1==1) { // // } else { // // } 或者 /* if (1 == 1) { // 如果1与1相等的时候 String code1; } else { // 如果1与1不相等的时候 String code2; }*/ 5. 分支语句的注释 目的：简单描述该分支条件的意义 书写规范：在分支语句代码的下一行进行注释 示例： if (1==1) { //如果1与1相等的时候 code } else { //如果1与1不相等的时候 code } 6. 变量、常量的注释 目的：简单描述该变量、常量的意义。 书写规范：变量、常量注释必须写在变量、常量定义之前或同一行中，简单描述其代表的意义。 注：对自循环所用的变量（i,j,k,）可以不需要注释。 示例： String commitFlag; //提交标志 6、 异常处理规范 重新抛出的异常必须保留原来的异常，即throw new NewException("message", e); 而不能写成throw new NewException("message")，更不能不继续往上层抛出异常。 针对重要的可捕获的业务相关异常，需创建异常处理类，在方法中捕获到异常后，反馈到用户界面上，提示用户【推荐】 7、 补充规范 a) 工程完善后的代码中不允许出现system.out.println(),alert()等临时调试代码； b) 明确的无用代码必须删除 c) 数据库表命名：zw_xxjbxxb、JW_bjjbxxb、JZG_ksjbxxb等。 数据库命名： PAGE 第 2 页 共 13 页