java编码规范XML:名称空间前缀=o ns=" urn: schemas-microsoft-com:办公室:办公室"/>
翻译:王士勇
(转载请保留作者,谢谢)
<标题> 1只;引言1.1。为什么要编码规范
编码规范为什么是重要的?有以下一些理由:
l 一份软件80%的生命周期是维护期
l 任何软件都很难说他的整个生命周期都是由他的原始作者来维护
l 编码规范改善软件的可读性,使得软件工程师充分理解新的代码变得非常的快速。
l 如果你要把你的原码作为产品发布,你需要确保他像你的其他产品一样干净并且封装的好。
为了按照规范工作,每个人写软件的时候,都必须遵守编码规范。记住,是每个人!
1.1.1又是;致谢
这本书是反映的是Java语言规范中关于Java语言编码规范的。在这里要着重对彼得。金,帕特里克·诺顿Mike DeMoney Jonni卡内尔瓦,Kathy点击数和斯科特·霍梅尔表示感谢。
<标题> 2只;文件名这一节列出了本书所用的大部分文件名和后缀。
2.1。文件后缀
,.java java源文件后缀
,. class,java字节码文件后缀
2.2。常用的文件名
,经常使用的文件名包括以下:
,gnumakefile ,首选的makefile的名字,我们使用gnumake来构建我们的软件。
,自述,那些专门概述特定文件夹内容的文件的首选的名字
<标题> 3只;文件的组织一个文件的各个部分之间应该用空行隔开,并且应该用一个可选的注解来标示每个不同的部分。
文件超过2000行,是非常笨重讨厌(麻烦)的,应该避免。
至于java编程的正确格式的示例,请参看18页上的“java源文件(java原码文件示例)”。
3.1。Java源码文件
,每一个Java源码文件都包括一个唯一的公共类或接口。当私有的类和接口都和这个公共类有关联时,你可以把它们放到这个公共类的源文件中。这个公共类或接口应当是这个文件的第一个类或接口。
Java源文件有以下的顺序:
l 文件开头注解(参见第二页的“开始评论(开头注解)”)
l ,声明包的语句和载入语句。
l 类和接口的声明(参见第3页的“类和接口声明”)
3.1.1又是;开头注解
,所有的源文件都应该以一个C语言风格的注解开头。这个注解应该列出类名,版本信息,日期和版权声明:
,/*
,*名称
,*
,*版本信息
,*
,*日期
* *版权声明
,
, *
, */
3.1.2又是;声明包的语句和导入语句
,绝大多数java源文件中的第一非注释行应该是声明包的语句。此后,紧接着是导入语句例。如:
,包java.awt;
,进口java.awt.peer.CanvASPeer;
3.1.3又是;类和接口的声明
下面的表格描述了部分的类和接口的声明,他们应该按照表格的顺序。参看18页Java源文件的例子。
,
部分类/接口声明,
注释
类/接口文档注解/* *…*/
如何做此类注解请参看“文档注释”
类或接口声明
类/接口实现的注解(/*…*/),如果有必要的话
这个注解应该包括任何整个类或接口范围内的不适合在类/接口文档注解中出现的内容。
类(静态)变量
首先是公共类变量,然后是保护类变量,然后是友好(包级别,即默认),然后是私人变量。
实例变量(译注:实体变量?不会翻译了,意即普通的变量。)
首先是公共的,其次保护,接着包级别。最后是私人变量。
类的构造函数
方法,(译注:即类的成员函数)
这些方法应该以功能相近为标准,组织在一块,而不是看其作用域和可存取性,例如:一个私有类方法(译注:意即私有静态方法)可以被放在两个公共实例方法(译注:意即公共方法)中间。其目的是为了代码可读性和可理解性增加。
<标题> 4只;缩进应该以四个空格为缩进的最小单位,缩进的精确结构没有被详细定义.Tabs必须被精确指定为8个空格(而不是4个)。
