项目开发规范.docx

项目开发规范1. Java编程规范1.1命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。1.Package的命名：包的名字都由一个小写字母组成。2.Class的命名：类名必须由大写字母开头，其它字母都小写的单词组成。3.方法的命名：方法名必须由一个小写字母开始，后面的单词用大写字母开始。4.变量的命名：变量名必须由一个小写字母开始，后面的单词用大写字母开始。5.Static final变量的命名：static final变量的名字应该都大写,并且指出完整含义。6.数组的命名：数组应该以byte buffer的形式，而不是byte buffer的形式定义。1.2Java文件样式1.版权信息：版权信息必须在java文件的开头，比如：/*Copyright 2000 Shanghai XXX Co. Ltd.*All right reserved*/2. 数据库设计规范2.1命名规范 1.数据库文件名：使用汉语拼音或者英文单词作为文件名，一律使用小写。 2.数据库表名称：数据库表名由前缀tb加实际名字组成，实际名字英文首字母大写 3.数据库表字段名称：每个单词首字母大写。 4.sql语句规范：所有sql语句关键词如：select，update等均大写。3. 网页设计约定3.1命名规范 1.所有控件id号均由开发人员名称首字母作为前缀。 2.js代码命名规范参考java编程规范。4. 文档书写规范4.1需求分析书写规范 1.目的和对象：简明编写需求说明书的目的，指明读者对象； 2.项目背景描述： a.项目的委托单位、开发单位和主管部门。 b.该软件系统与其他系统的关系，描述本项目的适应场合及处理业务。 c.项目名称：本项目的名称，包括项目的全称、简称、代号、版本号。 d.名称定义：列出文档中用到的专门术语的定义和缩写词的原文，对重要的或者有特殊意义的名词进行定义。 3.调研情况描述：描述主要的调研活动及对象。4.用户特点：a.用户业务描述：描述适用本项目处理的业务。b.用户情况：介绍本项目的用户情况，包括：用户的工作流程；用户的相关部门及职责；用户的技术水平；用户原有系统的情况：介绍用户现在使用的系统的主要情况，包括主要的不足。5.任务概述a.阐明本项目要达到的目标。b.作用范围及其他应向读者说明的有关软件开发的背景材料。解释被开发软件与其他软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统 的组成和本产品同其他各部分的联系和接口。6.运行环境a.硬件环境：详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置（如主机、显示器、外部设备等）及其他特殊设备。b.软件环境：如操作系统、网络软件、数据库系统及其其他特殊软件要求。c.条件和限制：说明本软件产品在实现时所必须满足的条件和所受的限制，以及相应的原因。必须满足的条件包括输入数据的范围及格式，所受的限制包括软件环境、硬件环境等方面的内容。d.主要特点：说明本软件产品与同类产品相比的特点，即卖点。7.功能需求a.功能划分：从用户的角度讲产品按功能划分成不同的部分，但应注意此处划分成的部分并不对应于最终程序实现时的不同功能模块。b.功能描述：细化由功能划分所生成的各部分的内容，应包括：必须完成的功能及对此功能的详细描述；不支持的功能及相应的原因，要求描述详细准确、无歧义，以作为将来验收和测试的标准。用表格的方式逐条列出每项功能，说明输入，处理过程，输出结果。8.数据描述a.静态数据：包括长期或暂时存储的数据。b.动态数据：包括输入数据和输出数据。c.外部数据：外部数据的处理和输入规定。d.输入/输出数据：说明输入/输出数据的类型及格式。9.性能要求a.数据精确度：根据实际情况，确定产品最终输出数据的数据精确度。b.时间特性：说明产品在响应时间、更新处理时间，数据转换与传输时间，运行时间等方面所需达到的时间特性。c.适应性：重用性：说明