java编码规范培训.pptVIP

简介 本文提供一整套编写高效可靠的 Java 代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，作为一个 Java 软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。 最根本的原则 运用常识。当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时侯： 运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少的。 参考SUN java SDK中的代码，这些代码、注释是比较标准的。 程序设计标准 Java 的程序设计标准很重要，原因在于它将提高开发团队各成员的代码的一致性。一致性的提高会使代码更易理解，这意味着它更易开发和维护。从而降低了应用程序的总开发成本。 你必须牢记的是：你的 Java 代码在你已离开并开始另一个项目之后，会保留相当长的一端时间。因此开发过程中一个很重要的目标就是要确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作。如果代码难以理解，很有可能被废弃和重写。 命名约定 我们将在整个标准中讨论命名约定，所以让我们先讨论几个基本点 命名约定--使用可以准确说明变量/字段/类的完整的英文描述符 例如，采用类似 firstName，grandTotal 或 CorporateCustomer 这样的名字。虽然象 x1，y1 或 fn 这样的名字很简短，输入起来容易，但是我们难以知道它们代表什么、结果是什么含义，因而使代码难以理解、维护和改进。 命名约定--采用该领域的术语 如果用户称他们的“客户” (clients) 为“顾客” (customers)，那么就采用术语 Customer 来命名这个类，而不用 Client。许多程序开发者会犯的一个错误是，不去使用工业或领域里已经存在着很完美的术语时，却生造出一些普通词汇。 命名约定--采用大小写混合，提高名字的可读性 一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写 命名约定--尽量少用缩写，但如果一定要使用，就要谨慎地使用 这意味着应该保留一个标准缩写的列表，明智地从中选取，并且在使用时保持一致。例如，想对单词“number”采用缩写，那么可从 nbr，no 或者 num 中选取一个，说明一下采用了哪一个（具体是哪个倒无所谓），并且只使用这一种形式。 命名约定--避免使用长名字 虽然 PhysicalOrVirtualProductOrService 看起来似乎是个不错的类名，但是这个名字太长了，应该考虑重新给它起个短一点的名字，比如象 Offering。 命名约定--避免使用相似或者仅在大小写上有区别的名字 例如，不应同时使用变量名 persistentObject 和 persistentObjects，以及 anSqlDatabase 和 anSQLDatabase。 注释约定 注释应该增加代码的清晰度 避免使用装饰性内容，也就是说，不要使用象广告横幅那样的注释语句 保持注释的简洁 先写注释，后写代码 注释信息不仅要包括代码的功能，还应给出原因 成员函数标准 命名成员函数 成员函数的命名应采用完整的英文描述符，大小写混合使用：所有中间单词的第一个字母大写。成员函数名称的第一个单词常常采用一个有强烈动作色彩的动词。 示例： openAccount() printMailingLabel() save() delete() 这种约定常常使人一看到成员函数的名称就能判断它的功能。虽然这种约定要使开发者多做一些输入的工作，因为函数名常常较长，但是回报是提高代码的可理解性。 命名存取成员函数 获取函数 获取函数作为一个成员函数，返回一个字段的值。除了布尔字段之外，应采用 get 作为字段的前缀；布尔字段采用 is 作为前缀。 示例： getFirstName() getAccountNumber() isPersistent() isAtEnd() 遵循这个命名约定，显然，成员函数将返回对象的字段，布尔型的获取函数将返回布尔值“真”或者“假”。这个标准的另一个优点是：它遵循 beans development kit (BDK) 对获取成员函数采用的命名约定 [DES97]。它的一个主要的缺点是 get 是多余的，需要额外的录入工作。 设置函数 设置函数，也叫变值函数，是可以修改一个字段值的成员函数，。无论何种字段类型，都要在字段名的前面加上 set 前缀。 示例：