Java编程规范手册.doc

1、如有你有帮助，请购买下载，谢谢！网道Java编程规范一、目的：本规范立足于所收集到的各种Java编码标准、规范、惯例以及指导性原则，根据本公司的具体情况进行调整后制定而成，其目的是便于软件代码易于理解、维护以及重用。更为重要的事，遵循这些标准可以显著地提高软件生产率。记住：编码是具有集体性质的，其易读性、易维护性是编码优良的重要评判标准。二、原则1 尽量添加注释。2 为人编码，而不是为电脑编码。3 先做设计，然后编码。4 保持代码简单。5 从小到大编制。切忌一上手就编制大规模代码。三、基本规范1注释在Java中，存在三种注释，分别为：l 文档注释：/*/；l 多行注释：/*/；l 单行注释：/

2、。这三种注释将用于不同的位置。1.1 原则l 尽可能进行代码注释。l 力求注释简洁、清楚、易懂。l 先写注释，再写代码l 除了注释代码功能外，更为重要的是注释出为什么要这样做，便于别人知道你写这段代码的目的。1.2 注释规范注释类型用途例子备注文档注释（/*/）1. 类（Class）2. 接口（Interface）3. 成员函数（Member Function）4. 属性（Attribute, Field）的声明前面。/*Customer A customer is any person or organization that we sell services and products to

3、.author S.W. Ambler*/由于Javadoc能文档注释中的某些特定元素，故文档注释通常用于书写项目文档。多行注释（/*/）注释掉暂时不使用的代码。/*This code was commented out by J.T. Kirk on Dec 9, 1997 because it was replaced by the preceding code. Delete it after two years if it is still not applicable. . . (the source code )*/表明这段源代码暂时不使用。可能在以后会改变主意使用它。必须说明原因

4、。单行注释（/）用于成员函数中说明：1. 程序逻辑2. 代码片断3. 临时变量声明等/ Apply a 5% discount to all invoices/ over $1000 as defined by the Sarek/ generosity campaign started in/ Feb. of 1995.建议采用单行注释来进行代码中的说明性行为。1.3 注释的内容名称注释内容Javadoc参数参数Arguments/Parametersl 参数类型l 用途l 使用的约束或者前提条件l 尽量给出一个示例属性Fields/Attributesl 属性描述l 所有可能的取值或取值范

5、围l 示例l 并发中可能存在的问题l 可见性设置。通常属性都设置为“私有”类型，如果设置不一样，请给出原因。l see ClassNamel see ClassName#memberFunctionName成员函数（外部）Member Functionsl 功能、用途以及编写该成员函数的原因l 输入的参数l 返回值l 该函数抛出的“例外”以及抛出的条件l 已知的缺陷l 可见性设置l 代码更改历史l 示例（如何调用该成员函数）l 可能的约束和前提条件l 并发性策略l param name descriptionl return descriptionl exception name descri

6、ptionl deprecatedl sincel see ClassNamel see ClassName#memberFunctionName成员函数（内部）Member Functionsl 注释局部变量l 注释复杂的代码l 注释控制结构，如分支、循环等，表明其控制流向及意图l 注释代码功能以及缘由局部变量Local Variablesl 用途实例变量Instance Variablesl 用途类Classesl 类的用途l 类实例的所有取值获取值范围l 已知的缺陷（通常在功能尚未完善时）l 类的开发/维护历史l 并发策略l authorl deprecatedl sincel see

7、ClassNamel see ClassName#memberFunctionNamel version接口Interfacesl 功能、用途l 什么情况下适用该接口l 什么情况下不适用该接口l authorl see ClassNamel see ClassName#memberFunctionNamel version包Packagesl 文件名l 包名l 版权信息l 用途l 所涉及的相关包l 所包含的类l 开发/维护历史2命名2.1 原则l 采用有明确意义的英文单词全名（通常为名词、动词）作为描述符，但不宜于太长（一般不超过20个字符）。l 每一个代码行限制在80个字符以内l 采用常见的

8、专业术语。l 混合大小写形式，便于阅读。通常在定义名称时，采取名称中的每一个单词首字母大写（第一个单词首字母小写），其余字母小写的形式。l 尽量不要采用缩写形式，在其缩写已经被广泛接受的情况下，采用相应的缩写方式，如URL, HTML, XML等。l 虽然Java是大小写敏感的语言，但避免采用只是大小写不同的名称。如lastName和LastName等l 避免使用下划线（ _ ）以及 $ 符号，特别是前导或后置下划线。因为这些变量经常被用作系统变量。只是在常数定义中，因采用大写形式而加入下划线以增加可读性。2.2 允许的缩写名称缩写形式备注messagemsgmanagermgrdatabas

9、eDbcommandCmdimplementationimpl2.3 命名规范名称命名规范例子备注参数Arguments/Parametersl 该参数的英文单词l 第一个英文单词首字母小写l 集合参数采用复数形式firstNamelastNamecustomers属性Fields/Attributesl 该属性的英文单词l 第一个英文单词首字母小写l 集合属性采用复数形式firstNamelastNamewarpSpeedorderItemscustomers布尔形Get函数Boolean Getter Member Functionsl is + 函数名l has +函数名l can +函

10、数名isPersistent()isString()一般Get函数Getter Member Functionsl get + 函数名getFirstName()getLastName()getWarpSpeed()Set函数Setter Member Functionsl set + 函数名setFirstName()setLastName()setWarpSpeed()成员函数Member Functionsl 尽量以一个英文动词开头l 第一个英文单词首字母小写openFile()addAccount()测试函数l test + 函数名testOpenFile()主要是便于系统测试。在测试

11、完成以后，可以搜索测试函数，将其注释调即可。局部变量Local Variablesl 第一个英文单词首字母小写，其余单词首字母大写l 不要采用仅仅是大小写不同的局部变量grandTotalcustomernewAccount实例变量Instance Variablesl 采用与对象意义相关的l 与普通变量命名法则相同循环计数器Loop countersl 采用惯例i, j, k, counter例外Exceptionsl 采用惯例e常数Constantsl 所有单词采用大写形式l 单词之间用下划线分隔，以便于阅读MIN_BALANCEDEFAULT_DATE类Classesl 所有单词的首字母

12、均大写CustomerSavingsAccount接口Interfacesl 所有单词的首字母均大写ContactablePrompterSingleton为了明确意义，通常最后一个单词有后缀，如“-able”、“-ible”和“-er”等。包Packagesl 包中各标识符用句点（.）分隔l 由Sun公司发布的标准包是以“java”标识符开头的l 局部包由小写的标识符分隔而成l 全球发行的包由公司域名倒写而成java.awtpersistence.mapping.rationalinterface.screensdao.www.interface.screensdao.www.naisa.d

13、ispatcher析构器Destructorsl Java本身没有析构器，但可以激活名为finalize()的函数finalize()组件Components/Widgetsl 组件描述符 + 类型全名l 第一个单词首字母小写okButtoncustomerListfileMenu构建器Constructorsl 名字与类名完全相同Customer()SavingsAccount()文件名Filesl 主类名 + “.java”Customer.javaSavingsAccount.java四、格式1源文件基本组织在源文件中，建议采用以下组织。序号内容例子1包注释/*FILE: MySourceFile.javaPACKAGE: Copyright (c) 2000 NetDao, Inc. All Rights ReservedCommentsHistory:2000/10/20 : Developer Name Change some code2000/09/12 Developer Name Add Member Function2000/09/01 Developer Name Create this file*/2包名package ;3引入Java公共包import ;4引入第三方包import com.weblogic.*;5引入自己的项目包import ;6类