YKTSJAVA编程规范剖析.docVIP

某公司 ? 文件编号：YKTS030 保密级别：公司? ? ? JAVA语言编程规范 ? ? ? ? 编 制： 审 核： 批 准： 存放位置： 某公司 发布文档修订记录 版本编号或者更改记录编号 变化状态 简要说明（变更内容和变更范围） 日期 变更人 批准日期 准人 *变化状态：C——创建，A——增加，M——修改，D——删除 目录 JAVA语言编程规范 1 第一章 命名规范 4 1.1 包（Package）命名 4 1.2 接口和类（Interface Class）命名 4 1.3 方法（Method）命名 4 1.4 变量（Variable）命名 5 第二章 程序的布局和风格 5 2.1 JAVA文件布局 5 2.1.1 版权信息声明 5 2.1.2 package和 import部分 5 2.1.3 类和接口声明部分 6 2.2 声明和语句布局 6 2.2.1 变量、类和接口的声明 6 2.2.2 语句 7 2.3 缩进和空格的使用 8 2.3.1 缩进规则 9 2.3.2 续行规则 9 2.3.3 空行的使用 10 2.3.4 空格的使用 10 第三章 注释 10 3.1 代码注释 10 3.1.1 常规注释 11 3.1.2 单行注释 11 3.1.3 行尾注释 11 3.1.4 标注型注释 11 3.2 文档注释 11 第四章 有关Java编程的若干建议 12 第一章 命名规范 命名规范主要是针对如下范畴： 包――Package 接口、类――Interface, Class 方法――Method 变量 基本原则 含义清晰，尽量体现出名字在程序中的逻辑含义 风格一致，即前后的缩写保持一致，整个程序使用的命名风格一致。 1.1 包（Package）命名 （1）统一使用小写单词加分隔符“.”来为Package命名； （2）Package的名字使用类似于域名的层次结构。Package名的前缀固定为“com.xxxxx.”，其中xxxxx为公司名（或数据库项目名称），具体名字待定; （3）Package的层次结构和命名由研发经理统一划定，划分在每个层次下的类和子Package应该是逻辑相关的。 1.2 接口和类（Interface Class）命名 （1）接口和类的名字由若干首字母大写的单词组成，已经约定成俗的大写术语以及相应的缩略语除外; （2）尽量使用名词性短语； （3）尽量少的使用缩略语，除非该缩略语已经成为规范，比如ULR,GSM等； （4）保存接口和类的文件的名字与其中声明为“public”接口和类的名字必须完全相同。 1.3 方法（Method）命名 （1）第一个单词的首字母小写，后续单词的首字母大写; （2）尽量使用动词性短语作为方法的名字； 1.4 变量（Variable）命名 （1）第一个单词的首字母小写，后续单词的首字母大写; （2）类的成员变量添加“m_”前缀； （3）Static Final类型的变量采用全部大写的形式，并使用下划线对单词进行分割； （4）对于作用域很小的临时变量和循环变量，可以使用类似“i, j, k”的单字符表示，否则不能使用单字符表示变量； （5）方法内的局部变量的命名尽可能简短，但意义必须明确； （6）方法参数的命名规则与变量的命名规则相同 第二章 程序的布局和风格 2.1 JAVA文件布局 一个源文件中包含一个public类或接口。下面按照在文件中出现的先后顺序来描述JAVA语言中一个类或者接口文件中应该具备的各个组成成份。 2.1.1 版权信息声明 格式如下： /* * 类或接口的名字 * 版本信息 * 创建时间 * Copyright 2003, … … * All rights reserved. * … … */ JAVA工具javadoc可以自动提取类或者接口文件中的有关注释信息作为帮助文档。“版权信息声明”部分不会出现在由javadoc提取的帮助文档中。所以，可以在此部分添加不希望出现在帮助文档中的有关信息 2.1.2 package和 import部分 package com.xxxx. import部分紧跟在package声明之后（以一空行分割）。Import的顺序为： （1）标准的JAVA packages （2）第三方的packages （3）本地的packages 每部分之间使用一个空行进行分割。同一部分尽量按照package名的字典顺序进行排列。 2.1.3 类和接口声明部分 下表按照先后顺序罗列出类和接口声明部分可能会包括的内容： 编号 内容 注释 1 类/接口文档注释 有关此部分应包括的内容参见帮助文