编码规范
1.
1.
1.
1. 介绍 (Introduction)
1.1.
1.1.
1.1.
1.1. 为什么要有编码规范 (Why
(Why
(Why
(Why Have
Have
Have
Have Code
Code
Code
Code Conventions)
Conventions)
Conventions)
Conventions)
编码规范对于程序员而言尤为重要,有以下几个原因:
• 一个软件的生命周期中, 80% 的花费在于维护。
• 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。
• 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。
• 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品。
为了执行规范,每个软件开发人员必须一致遵守编码规范。每个人
1.2.
1.2.
1.2.
1.2. 版权声明 (Acknowledgments)
本文档反映的是 Sun MicroSystems 公司, Java 语言规范中的编码标准部分。主要贡献者包括: Peter King , Patrick
Naughton , Mike DeMoney , Jonni Kanerva , Kathy Walrath 以及 Scott Hommel 。
本文档现由 Scott Hommel 维护,有关评论意见请发至 shommel@eng.sun.com
2.
2.
2.
2. 文件名 (File Names)
这部分列出了常用的文件名及其后缀。
2.1.
2.1.
2.1.
2.1. 文件后缀 (File
(File
(File
(File Suffixes)
Suffixes)
Suffixes)
Suffixes)
Java 程序使用下列文件后缀:
• Java 源文件 .java
• Java 字节码文件 .class
2.2.
2.2.
2.2.
2.2. 常用文件名 (Common
(Common
(Common
(Common File
File
File
File Names)
Names)
Names)
Names)
常用的文件名包括:
• GNUmakefile makefiles 的首选文件名。我们采用 gnumake 来创建( build )软件。
• README 概述特定目录下所含内容的文件的首选文件名 。
3.
3.
3.
3. 文件组织内容编排 (File Organization)
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过 2000 行的程序难以阅读,应该尽量避免 。
"Java 源文件范例 " 提供了一个布局合理的 Java 程序范例。
3.1.
3.1.
3.1.
3.1. Java
Java
Java
Java 源文件 (Java
(Java
(Java
(Java Source
Source
Source
Source Files)
Files)
Files)
Files)
每个 Java 源文件都包含一个单一的公共类或接口 。 若私有类和接口与一个公共类相关联 , 可以将它们和公共类放入同
一个源文件。公共类必须是这个文件中的第一个类或接口。
Java 源文件还遵循以下规则: