java编程规范指南

《java编程规范指南》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Java编程指南目录简介6最根本的原则：6程序设计标准6命名约定6注释约定7成员函数标准10命名成员函数10命名存取成员函数11获取函数11获取函数的另一种命名约定。Has和Can11设置函数12命名构造函数12成员函数的可见性12注释成员函数13成员函数的函数头13内部注释15编写清晰整洁的代码的技巧16给代码加上注释16让代码分段/缩进16遵循30秒条法则17写短小单独的命令行17说明运行顺序17字段标准（字段/属性）17命名字段18命名组件（部件）18命名常量19命名集合19字段可见性20不要“隐藏”名字20注释一个字段20使用存取成员

2、函数21为什么使用存取函数？22命名存取函数22存取函数的高级技术23存取函数的可见性28一定要初始化静态字段28局部变量标准28命名局部变量29命名流29命名循环计数器29命名异常对象29声明并注释局部变量29关于声明的一般注释30成员函数的参数标准30命名参数30注释参数31类、接口、包和编译单元的标准31类的标准32命名类32注释类32类的声明33将公共和保护接口最小化34接口标准34命名接口34注释接口35包的标准35命名包35注释包36编译单元标准36命名编译单元36注释编译单元37错误处理和异常37其他标准和版本38复用38导入类

3、39优化Java代码39编写Java测试集40成功的模式40有效地使用这些标准41其它导向成功代码的因素41总结43Java命名约定43Java注释约定45Java注释类型45注释哪些部分46Java程序设计约定（一般）48参考文献50词汇表51简介本文提供一整套编写高效可靠的Java代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个Java软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最

4、后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。最根本的原则：运用常识。当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时侯：运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少的。程序设计标准Java的程序设计标准很重要，原因在于它将提高开发团队各成员的代码的一致性。一致性的提高会使代码更易理解，这意味着它更易开发和维护。从而降低了应用程序的总开发成本。你必须牢记的是：你的Java代码在你已离开并开始另一个项目之后，会保留相当长的一端时间。因此开发过程中一个很重要的目标

5、就是要确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作。如果代码难以理解，很有可能被废弃和重写。命名约定我们将在整个标准中讨论命名约定，所以让我们先讨论几个基本点：1.使用可以准确说明变量/字段/类的完整的英文描述符。例如，采用类似firstName，grandTotal或CorporateCustomer这样的名字。虽然象x1，y1或fn这样的名字很简短，输入起来容易，但是我们难以知道它们代表什么、结果是什么含义，因而使代码难以理解、维护和改进。2.采用该领域的术语。如果用户

6、称他们的“客户”(clients)为“顾客”(customers)，那么就采用术语Customer来命名这个类，而不用Client。许多程序开发者会犯的一个错误是，不去使用工业或领域里已经存在着很完美的术语时，却生造出一些普通词汇。1.采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写[KAN97]。强制：类接口名首字大写，常量大写，其他首字小写。2.尽量少用缩写，但如果一定要使用，就要谨慎地使用。这意味着应该保留一个标准缩写的列表，明智地从中选取，并且在使用时保持一致。例如，

7、想对单词“number”采用缩写，那么可从nbr，no或者num中选取一个，说明一下采用了哪一个（具体是哪个倒无所谓），并且只使用这一种形式。3.避免使用长名字（最好不超过15个字母）。虽然PhysicalOrVirtualProductOrService看起来似乎是个不错的类名，但是这个名字太长了，应该考虑重新给它起个短一点的名字，比如象Offering。4.避免使用相似或者仅在大小写上有区别的名字。例如，不应同时使用变量名persistentObject和persistentObjects，以及anSqlDatabase和anSQLDat

8、abase。5.避免使用下划线作为名字的首末字母。以下划线为首末字母的名字通常为系统保留，除预处理定义之外，一般不用作用户命名。更重要的是，下划线经常造成麻烦而且难