qg280103-java程序设计规范.docVIP

JAVA 程序设计规范 文件编号： SDSI-QG-29-01-03 起草部门： 审 核 人： 批 准 人： 批准日期：2008年4月 日 版本标识： 1.0版 目 录 1 介绍 4 1.1目的 4 2 文件命名 4 2.1文件后缀 4 2.2公共文件名 4 3 文件组织 4 3.1 Java源文件 4 3.1.1 起始注释 5 3.1.2 Package和Import语句 5 3.1.3 class和interface声明 5 4 缩排风格 6 4.1 行的长度 6 4.2 分割行 6 5 注释 7 5.1 执行注释格式 8 5.1.1 块注释 8 5.1.2 单行注释 8 5.1.3 跟踪注释 8 5.1.4 行末注释 8 5.2 文档注释 9 6 声明 9 6.1 每行的数量 9 6.2 初始化 10 6.3 定位 10 6.4 类和接口声明 10 7 语句 11 7.1 简单语句 11 7.2 复合语句 11 7.3 return语句 11 7.4 if语句 12 7.5 for语句 12 7.6 while语句 12 7.7 do－while语句 13 7.8 switch语句 13 7.9 try－catch语句 13 8 空白区域 14 8.1 空行 14 8.2 空格 14 9 命名规范 15 10 编程惯例 15 10.1 访问实例和类变量 15 10.2 调用类变量和方法 16 10.3 常量 16 10.4 变量赋值 16 10.5 其他 16 10.5.1 括号 16 10.5.2 返回值 16 10.5.3 条件操作中‘？’前的表达式 17 11 一个完整的例子 17 介绍 1.1目的 编码规范对程序员是非常重要的： 维护过程占软件生命周期的80%； 几乎所有的软件在其整个生命周期中都不是由最初的作者进行维护的； 编码规范可以改善软件的可读性，使技术人员更快速、更彻底的理解新的代码； 如果想把源代码作为商品出售，你需要确定它是否像你创造的其他产品一样整洁和被良好的包装。 所以为了规范工作，每个编写软件的人都必须遵守编码规范 文件命名 2.1文件后缀 .java Java源代码 .class 编译后的执行代码 2.2公共文件名 readme 概括一个特殊目录内容的首选文件名 文件组织 每个文件中的各个段落都应该通过空行分隔开，并添加注释说明。 每个文件应该避免超过2000行。 3.1 Java源文件 每个Java源文件包含一个独立的public class 或 interface。当其他private class 和interface需要与public class关联在一起时，可以将它们存放在以public class名命名的文件里。public class应该是该文件中的第一个class或interface。 Java源文件应该按照下面的顺序： 起始注释 Package和Import语句 class和interface声明 3.1.1 起始注释 每个源文件的开始都应该有一个C语言风格的注释，列出类名，版本信息，日期和版权声明： /* * Classname * * Version information * * Date * * Copyright notice */ 3.1.2 Package和Import语句 大多数的Java源文件的第一个非注释行都是package语句，后面接着是import语句。例如： package java.awt; import java.awt.peer.CanvasPeer; 3.1.3 class和interface声明 下面的表格描述了class或interface声明的各部分。 声明中的各部分 说明 1 Class/interface文档注释(/**…*/) 见后面 2 Class或interface语句 3 Class/interface执行注释(/**…*/) 包含不适合文档注释的扩展注释 4 Class变量 首先public，然后protected，private 5 Instance变量 首先public，然后protected，private 6 构造函数 7 方法 各方法应首先按照功能排列，这样更易读、易理解。 4 缩排风格 每行前面要留出四个空格，表格前面要留出八个空格。 4.1 行的长度 每行不应超过80个字符，在文件中引用的例子每行应不超过70个字符 4.2 分割行 当一行无法写完一个表达式时，应按照下列规则进行分割： 在逗号后面断开； 在运算符前面断开； 断开低一级的表达式；