D_05_01_系统标识规范说明书解读.docVIP

汽车租赁信息管理系统 系统编码标示规范说明书 修订历史记录 日期 版本 说明 作者 1.0 初步识别系统的角色 系统编码标示规范 名称 Java语言编码规范(Java Code Conventions) 　译者 晨光（Morning） 　简介 本文档讲述了Java语言的编码规范，较之陈世忠先生《c++编码规范》的浩繁详尽，此文当属短小精悍了。而其中所列之各项条款，从编码风格，到注意事项，不单只Java，对于其他语言，也都很有借鉴意义。因为简短，所以易记，大家不妨将此作为handbook，常备案头，逐一对验。 　声明 如需复制、传播，请附上本声明，谢谢。原文出处：/docs/codeconv/html/CodeConvTOC.doc.html，译文出处：/，moyingzz@ 　目录 1 介绍 1.1 为什么要有编码规范 1.2 版权声明 2 文件名 2.1 文件后缀 2.2 常用文件名 3 文件组织 3.1 Java源文件 3.1.1 开头注释 3.1.2 包和引入语句 3.1.3 类和接口声明 4 缩进排版 4.1 行长度 4.2 换行 5 注释 5.1 实现注释的格式 5.1.1 块注释 5.1.2 单行注释 5.1.3 尾端注释 5.1.4 行末注释 5.2 文挡注释 6 声明 6.1 每行声明变量的数量 6.2 初始化 6.3 布局 6.4 类和接口的声明 7 语句 7.1 简单语句 7.2 复合语句 7.3 返回语句 7.4 if，if-else，if else-if else语句 7.5 for语句 7.6 while语句 7.7 do-while语句 7.8 switch语句 7.9 try-catch语句 8 空白 8.1 空行 8.2 空格 9 命名规范 10 编程惯例 10.1 提供对实例以及类变量的访问控制 10.2 引用类变量和类方法 10.3 常量 10.4 变量赋值 10.5 其它惯例 10.5.1 圆括号 10.5.2 返回值 10.5.3 条件运算符?前的表达式?前的表达式 10.5.4 特殊注释 11 代码范例 11.1 Java源文件范例 1 介绍(Introduction) 1.1 为什么要有编码规范(Why Have Code Conventions) 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。 1.2 版权声明(Acknowledgments) 本文档反映的是Sun MicroSystems公司，Java语言规范中的编码标准部分。主要贡献者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。 本文档现由Scott Hommel维护，有关评论意见请发至shommel@ 2 文件名(File Names) 这部分列出了常用的文件名及其后缀。 2.1 文件后缀(File Suffixes) Java程序使用下列文件后缀： 文件类别 文件后缀 Java源文件 .java Java字节码文件 .class 2.2 常用文件名(Common File Names) 常用的文件名包括： 文件名 用途 GNUmakefile makefiles的首选文件名。我们采用gnumake来创建（build）软件。 README 概述特定目录下所含内容的文件的首选文件名 3 文件组织(File Organization) 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。Java源文件范例提供了一个布局合理的Java程序范例。 3.1 Java源文件(Java Source Files) 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 Java源文件还遵循以下规则： - 开头注释（参见开头注释）- 包和引入语句（参见包和引入语句）- 类和接口声明（参见类和接口声明） 3.1.1 开头注释(Be