[计算机软件及应用]软件开发编码规范.pptVIP

软件开发编码规范 目的 本规范的目的是通过建立编码规范统一每个开发人员的编码习惯，提高程序的可靠性、可读性、可修改性、可维护性及一致性，增加团队合作开发效率，为各项目组之间或项目组内成员之间的技术交流提供一个方便统一的方式。 范围 本规范适用于公司内所有运用JAVA技术的软件项目、产品等的设计、开发以及维护、升级等。 本规范适用于公司所有JAVA软件开发人员。 本规范建议的开发环境与工具如下： IDE:Eclipse3.3.2以后版本 插件:MyEclipse6.0以及eclipse3.6以后版本 JDK: Sun JDK 1.5以上 格式规范 对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使软件开发团队中的程序员能够很容易地理解代码。 代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。 因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。 格式规范 缩进：一个TAB 缩进 换行：一般不超过80个字符 间隔：类、方法及功能块间等应以空行相隔 对齐：关系密切的行应对齐，对齐包括类型、修 饰、名称、参数等各部分对齐 括号：括号中的语句应该单独作为一行 例如 public class UserInfo{ private String username=“Harbin”; public static void main(){ System.out.println(username); } } 注释规范 基本原则: 注释应该增加代码的清晰度。代码注释 的目的是要使代码更易于被其他开发 人员等理解。 注释信息不仅要包括代码的功能，还应给出原因。 除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。 文件注释 在每个文件、包的头部都应该包含该文件的功能、作用、作者、版权以及创建、修改记录等。并在其中使用版本仓库标记自动跟踪版本变化及修改记录等信息。注意是标准的C-Style/*...*/ 注释而不是/* ...*/ 形式的JavaDoc 注释，在ECLIPS中使用CODE TEMPLATES会自动添加。 例如 /* * @(#) Test1.java * Created Date: Sep 11, 2008 * * Copyright (c) Jiangsu Ecode Co., Ltd * * This software is the confidential and proprietary information of * Jiangsu Ecode Co., Ltd. (Confidential Information). You shall not * disclose such Confidential Information and shall use it only in * accordance * with the terms of the license agreement you entered into with * Jiangsu Ecode Co., Ltd. */ Java Doc 注释 对类、方法、变量等的注释需要符合JavaDoc 规范，对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML 标记格式化注释，以使生成的JavaDoc易阅读和理解。 类注释中当包含版本和作者信息，使用版本仓库的标记自动跟踪版本变化和修改记 录。 例如 /** * 用于示例的类 * * @author a * href=mailto:xiating@Xiating/a * @version $Rev$ br * $Id: Test1.java,v 1.2 2008/09/17 02:25:08 cvsroot Exp $ */ public class Test1 { private static final Logger logger = Logger.getLogger(Test1.class); /** *一个测试的方法 *@param userid 用户编号 *@return 返回用户信息对象，若无该用户信息，则返回null */ private UserInfo getStrings(Integer userid) { …………… return userInfo; } } 代码细节注释 由// 界定，专用于注释代码细节，即使有多行注释也仍然使用//，以便与用/**/注 释的失效代码分