门户产品开发规范开发规范
(提交稿)
北京XXXX软件股份有限公司
2009年4月
文档说明
本文档所涉及到的文字、图表等，仅限于北京XXXX软件股份有限公司内部使用，未经双方书面许可，请勿扩散到第三方。
文档属性
文档变更
文档送呈
目录
(提交稿) (1)
1概述 (5)
1.1最根本原则 (5)
2程序设计标准 (6)
2.1命名约定 (6)
2.2注释约定 (7)
2.3快速浏览JavaDoc (8)
3门户系统开发规范 (10)
3.1整体包结构说明 (10)
3.1.1常用包结构 (11)
3.1.2功能包结构 (12)
3.2命名规则 (13)
3.2.1共用类 (13)
3.2.2业务层 (13)
3.2.3展现层 (13)
3.2.4模型层 (14)
3.2.5持久层 (14)
3.2.6XML配置 (14)
3.2.7资源文件 (18)
3.2.8事务命名约束 (19)
3.2.9JS命名约束(待完善) (20)
1 概述
本文提供一整套编写高效可靠的Java代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个Java软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。
1.1 最根本原则
运用常识
当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时侯：运用常识并核实这些基本原则。这条规则比其它所有规则都重要。
常识是必不可少的。
2 程序设计标准
Java的程序设计标准很重要，原因在于它将提高开发团队各成员的代码的一致性。一致性的提高会使代码更易理解，这意味着它更易开发和维护。从而降低了应用程序的总开发成本。
你必须牢记的是：你的Java代码在你已离开并开始另一个项目之后，会保留相当长的一段时间。因此开发过程中一个很重要的目标就是要确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作。如果代码难以理解，很有可能被废弃和重写。
2.1 命名约定
我们将在整个标准中讨论命名约定，以下是几个基本点：
❒使用可以准确说明变量/字段/类的完整的英文描述符
例如，采用类似firstName，grandTotal 或CorporateCustomer这样的名字。
虽然象x1，y1或fn 这样的名字很简短，输入起来容易，但是我们难以知道它们代表什么、结果是什么含义，因而使代码难以理解、维护和改进。
❒采用该领域的术语
如果用户称他们的“客户”(clients) 为“顾客”(customers)，那么就采用术语Customer 来命名这个类，而不用Client。许多程序开发者会犯的一个错误是，不去使用工业或领域里已经存在着很完美的术语时，却生造出一些普通词汇。
❒采用大小写混合，提高名字的可读性
一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。
❒尽量少用缩写，但如果一定要使用，就要谨慎地使用
这意味着应该保留一个标准缩写的列表，明智地从中选取，并且在使用时保持一
致。例如，想对单词“number”采用缩写，那么可从nbr，no 或者num 中选取一个，说明一下采用了哪一个（具体是哪个倒无所谓），并且只使用这一种形式。
❒避免使用长名字（不超过15 个字母）
虽然PhysicalOrVirtualProductOrService 看起来似乎是个不错的类名，但是这个名字太长了，应该考虑重新给它起个短一点的名字，比如象Offering。
❒避免使用相似或者仅在大小写上有区别的名字
例如，不应同时使用变量名persistentObject和persistentObjects及anSqlDatabase和anSQLDatabase这样的名称
❒避免使用下划线作为名字的首末字母
以下划线为首末字母的名字通常为系统保留，除预处理定义之外，一般不用作用户命名。更重要的是，下划线经常造成麻烦而且难输入，所以尽量避免使用。
2.2 注释约定
本文还会对注释进行约定，以下是几个基本点：
❒注释应该增加代码的清晰度
代码注释的目的是要使代码更易于被同时参与程序设计的开发人员以及其他后继开发人员理解。
❒如果你的程序不值得注释，那么它也很可能也不值得运行。
❒保持注释的简洁
最好的注释应该是简单明了的注释。注释不必洋洋洒洒，只需提供足够的信息，使别人能够理解你的代码。
❒先写注释，后写代码
写代码注释的最好方法是在写代码之前就写注释。这使你在写代码之前可以想想代码的功能和运行。而且这样确保不会遗漏注释。另一种方法是边写代码边写注释。
因为注释可以使代码更易理解，所以在程序开发的过程中，也可以利用这一点。如果打算花些时间写注释，那么至少你应从这个过程中获得些什么。
注释信息不仅要包括代码的功能，还应给出原因
例如，下面例1中的代码显示金额在$1,000 以上（包括$1,000）的定单可给予5% 的折扣。为什么要这样做呢？难道有一个商业法则规定大额定单可以得到折扣吗？这种给大额定单的特殊是有时限的呢，还是一直都这样？最初的程序设计者是否只是由于慷慨大度才这样做呢？除非它们在某个地方（或者是在源代码本身，或者是在一个外部文档里）被注释出来，否则你不可能知道这些。
2.3 快速浏览JavaDoc
Sun 公司的Java Development Kit (JDK) 中有一个名为javadoc 的程序。它可以处理Java 的源代码文件，并且为Java 程序产生HTML 文件形式的外部注释文档。Javadoc 支持一定数目的标记，标识注释文档中各段起始位置的保留字。详情请参考JDK javadoc 文档。
