项目开发规范.docx

项目开发规范
Java编程规范

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
:包的名字都由一个小写字母组成。
:类名必须由大写字母开头,其它字母都小写的单词组成。
:方法名必须由一个小写字母开始,后面的单词用大写字母开始。
:变量名必须由一个小写字母开始,后面的单词用大写字母开始。
final变量的命名:static final变量的名字应该都大写,并且指出完整含义。
:数组应该以byte [] buffer的形式,而不是byte buffer[]的形式定义。

:版权信息必须在java文件的开头,比如:
/**
*Copyright ® 2000 Shanghai XXX Co. Ltd.
*All right reserved
*/
数据库设计规范

:使用汉语拼音或者英文单词作为文件名,一律使用小写。
:数据库表名由前缀tb加实际名字组成,实际名字英文首字母大写
:每个单词首字母大写。
:所有sql语句关键词如:select,update等均大写。
网页设计约定

。
。
文档书写规范

:简明编写需求说明书的目的,指明读者对象;
:
、开发单位和主管部门。
,描述本项目的适应场合及处理业务。
:本项目的名称,包括项目的全称、简称、代号、版本号。
:列出文档中用到的专门术语的定义和缩写词的原文,对重要的或者有特殊意义的名词进行定义。
:描述主要的调研活动及对象。
:
:描述适用本项目处理的业务。
:介绍本项目的用户情况,包括:用户的工作流程;用户的相关部门及职责;用户的技术水平;用户原有系统的情况:介绍用户现在使用的系统的主要情况,包括主要的不足。

。
。解释被开发软件与其他软件之间的关系。如果本软件产品是一项独立的软件,而且全部内容自含,则说明这一点。如果定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。

:详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)及其他特殊设备。
:如操作系统、网络软件、数据库系统及其其他特殊软件要求。
:说明本软件产品在实现时所必须满足的条件和所