门户系统开发规范(JAVA部分).docVIP

DOCPROPERTY project short name 门户产品开发规范 开发规范 ( DOCPROPERTY AM 提交稿) 北京XXXX软件股份有限公司 2009年4月 文档说明 本文档所涉及到的文字、图表等，仅限于北京XXXX软件股份有限公司内部使用，未经双方书面许可，请勿扩散到第三方。 文档属性 属性 内容 客户名称： DOCPROPERTY user full name XXXX软件股份有限公司 项目名称： SUBJECT DOCPROPERTY project full name XXXX软件股份有限公司门户产品 文档主题： DOCPROPERTY project short name 门户产品开发规范 文档编号： 文档版本： 0.1 版本日期： 2009-04-27 文档状态： DOCPROPERTY AM 提交稿 作者： DOCPROPERTY TC XXXX 文档变更 版本 修订日期 修订人 描述 1.0 2009-04-27 姜涛 创建文档结构 文档送呈 单位 姓名 目的 XXXX 审阅 XXXX 参阅 目 录 TOC \o 1-5 \h \z \u (提交稿) 1 1 概述 4 1.1 最根本原则 4 2 程序设计标准 5 2.1 命名约定 5 2.2 注释约定 6 2.3 快速浏览JavaDoc 7 3 门户系统开发规范 9 3.1 整体包结构说明 9 3.1.1 常用包结构 10 3.1.2 功能包结构 11 3.2 命名规则 12 3.2.1 共用类 12 3.2.2 业务层 12 3.2.3 展现层 12 3.2.4 模型层 13 3.2.5 持久层 13 3.2.6 XML配置 13 3.2.7 资源文件 16 3.2.8 事务命名约束 17 3.2.9 JS命名约束(待完善) 17 概述 本文提供一整套编写高效可靠的Java代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个Java软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。 最根本原则 运用常识 当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时侯： 运用常识并核实这些基本原则。这条规则比其它所有规则都重要。 常识是必不可少的。 程序设计标准 Java的程序设计标准很重要，原因在于它将提高开发团队各成员的代码的一致性。一致性的提高会使代码更易理解，这意味着它更易开发和维护。从而降低了应用程序的总开发成本。 你必须牢记的是：你的Java代码在你已离开并开始另一个项目之后，会保留相当长的一段时间。因此开发过程中一个很重要的目标就是要确保在开发成员或开发团队之间的工作可以顺利交接，不必花很大的力气便能理解已编写的代码，以便继续维护和改进以前的工作。如果代码难以理解，很有可能被废弃和重写。 命名约定 我们将在整个标准中讨论命名约定，以下是几个基本点： 使用可以准确说明变量/字段/类的完整的英文描述符 例如，采用类似firstName，grandTotal 或 CorporateCustomer这样的名字。虽然象x1，y1或fn 这样的名字很简短，输入起来容易，但是我们难以知道它们代表什么、结果是什么含义，因而使代码难以理解、维护和改进。 采用该领域的术语 如果用户称他们的“客户” (clients) 为“顾客” (customers)，那么就采用术语Customer 来命名这个类，而不用 Client。许多程序开发者会犯的一个错误是，不去使用工业或领域里已经存在着很完美的术语时，却生造出一些普通词汇。 采用大小写混合，提高名字的可读性 一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。 尽量少用缩写，但如果一定要使用，就要谨慎地使用 这意味着应该保留一个标准缩写的列表，明智地从中选取，并且在使用时保持一致。例如，想对单词“number”采用缩写，那么可从 nbr，no 或者 num 中选取一个，说明一下采用了哪一个（具体是哪个倒无所谓），并且只使用这一种形式。 避免使用长名字（不超过15 个字母） 虽然 PhysicalOrVirtualProductOrService 看起来似乎是个不错的类名，但是这个名字太长了，应该考虑重新给它起个短一点的名字，比如象 Offering