软件系统开发规范

系统开发规范

1、数据库使用规范

1.1服务器上有关数据库的一切操作只能由服务器管理人员进行。

1.2程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。

1.3原则上每一个频道只能建一个库，库名与各频道的英文名称相一致，库中再包含若干表。比较大的、重点的栏目可以考虑单独建库，库名与栏目的英文名称相一致。

1.4命名：

（1）数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文单词命名（尽量避免使用汉语拼音），对于一个单词难以表达的，可以考虑用多个单词加下划线（_）连接（不能超过四个单词）命名。

（2）所有的名称必须统一使用英文小写字母。

（3）所有的名称起始和结尾不能使用下划线（_）。

（4）所有的名称不能包含26个英文小写字母和下划线（_）以外的其他字符。

1.5不再使用的数据库、表应删除，在删除之前必须备份（包括结构和内容）。

2、文档规范

所有的项目必须有相关的文档说明（可以是电子文档）。文档应包含如下内容：

（1）项目名称。

（2）项目小组名单，项目负责人。

（3）项目开发起始时间和结束时间。

（4）项目内容描述。

（5）项目位置。（在哪个频道、哪个栏目）

（6）与项目有关的程序文件名（含路径名），文件内容及实现的功能描述。

（7）完整的程序流程图。

（8）数据库、表、视图、索引的名称，用途。字段的名称、类型、长度、用途，必须附上相关的SQL语句。

3、源代码与页面嵌套规范

3.1源代码：

（1）使用自定义变量（包括全局变量、局部变量）之前必须先声明变量，并用注释语句标明变量的类型、用途。

（2）自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义，返回值的类型。

（3）程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行，并注明该过程的功能。

（5）所有的注释文字一律使用简体中文。

3.2 HTML页面嵌套：

（1）网页设计部设计的HTML页面以嵌套的方式确定用于动态显示程序执行结果的位置、宽度、行数（或高度）等，并在相应位置予以文字说明。页面中与程序无关的图片、文字、联结等必须使用完整的URL。

（2）软件开发人员和编辑人员可以根据情况协商，将页面文件及图片与程序独立存放在各自的服务器上，页面改版和修改程序独立进行。

（3）使用include技术将分割开的HTML页面分别嵌入程序代码中，要求做到修改HTML页面时无须改写程序，而修改程序时不会影响HTML页面效果，将页面改版和修改程序两项工作分别独立。

（4）页面和程序嵌套以后不能破坏原HTML页面的整体显示效果，字体、字号、颜色等应尽量保持原HTML页面的风格。

（5）动态生成的页面的各项指标（如图片大小、页面宽度、高度、页面文件的字节数等）应符合本公司网页设计方面的要求。

4、测试规范（软件部分）

对于较大的项目应成立相应的测试小组，小组成员由软件开发人员、网页设计人员、技术人员、

编辑人员组成。测试过程应参照网页设计部为该项目提供的原HTML页面进行。测试内容包括以下几点：

（1）页面宽度、高度（行数）。

（2）页面文字、图片、色彩是否风格统一。

（3）页面的图片显示是否正常、有无变形。

（4）弹出页面的效果。

（5）页面的联接是否正确。

（6）动态生成的页面是否符合以上几个方面的要求，页面大小（字节数，包括页面的图片、*.js、*.css、*.class等相关文件）是否符合网页设计的要求。

（7）软件方面的功能是否实现。如数据库的查询、修改、删除，文件的上传、下载等操作是否正常。

（8）测试结束后，根据《软件开发需求书》在《测试报告》上如实填写测试结果，包括测试通过的、未通过的，指出出错的页面和相关的程序文件，并附上测试中出现的错误信息。