Java的语言编码规范.docVIP

Java语言编码规范 目录 1 介绍 4 1.1 为什么要有编码规范 4 1.2 目的 4 1.3 适用范围 4 2 文件名 5 2.1 文件后缀 5 2.2 常用文件名 5 3 文件组织 6 3.1 Java源文件 6 3.1.1 开头注释 6 3.1.2 包和引入语句 7 3.1.3 类和接口声明 7 4 缩进排版 8 4.1 行长度 9 4.2 换行 9 5 注释 12 5.1 实现注释的格式 13 5.1.1 块注释 14 5.1.2 单行注释 15 5.1.3 尾端注释 15 5.1.4 行末注释 16 5.2 文档注释 17 6 声明 18 6.1 每行声明变量的数量 18 6.2 初始化 19 6.3 布局 19 6.4 类和接口的声明 21 7 语句 22 7.1 简单语句 22 7.2 复合语句 22 7.3 返回语句 23 7.4 if，if-else，if else-if else语句 23 7.5 for语句 24 7.6 while语句 25 7.7 do-while语句 26 7.8 switch语句 26 7.9 try-catch语句 27 8 空白 28 8.1 空行 28 8.2 空格 29 9 命名规范 30 10 编程惯例 32 10.1 提供对实例以及类变量的访问控制 32 10.2 引用类变量和类方法 33 10.3 常量 33 10.4 变量赋值 33 10.5 其它惯例 35 10.5.1 圆括号 35 10.5.2 返回值 35 10.5.3 条件运算符?前的表达式 36 10.5.4 特殊注释 36 11 代码范例 37 11.1 Java源文件范例 37 1 介绍 1.1 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范每个人。 1.2 本规范的主要目的是描述E.E团队研发项目的编程约定，规范软件工程师的编码风格，使E.E团队的软件产品具有统一的风格，使得软件具有较高的可维护性和可复用性。 1.3 适用范围 本文档适用E.E团队的研发项目。 2 文件名 这部分列出了常用的文件名及其后缀。 2.1 文件后缀 Java程序使用下列文件后缀： 文件类别 文件后缀 Java源文件 .java Java字节码文件 .class 2.2 常用文件名 常用的文件名包括： 文件名 用途 GNUmakefile makefiles的首选文件名。我们采用gnumake来创建（build）软件。 README 概述特定目录下所含内容的文件的首选文件名 3 文件组织 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。Java源文件范例提供了一个布局合理的Java程序范例。 3.1 Java源文件 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 Java源文件还遵循以下规则： - 开头注释- 包和引入语句- 类和接口声明 3.1.1 开头注释 所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明： /* * Classname * * Version information * * Date * * Copyright notice */ 3.1.2 包和引入语句 在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如： package java.awt; import java.awt.peer.CanvasPeer; 3.1.3 类和接口声明 下表描述了类和接口声明的各个部分以及它们出现的先后次序。 ? 类/接口声明的各部分 注解 1 类/接口文档注释(/**……*/) 该注释中所需包含的信息 2 类或接口的声明 ? 3 类/接口实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。 4 类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。 5