软件工程与项目管理--大作业(封面).docx

《软件工程与项目管理--大作业(封面).docx》由会员分享，可在线阅读，更多相关《软件工程与项目管理--大作业(封面).docx（44页珍藏版）》请在三一办公上搜索。

1、 浙江大学宁波理工学院2010-2011学年（1）软件工程与项目管理课程设计开课分院： _课程设计题目：_小组成员： _（组长）_完成日期：_目 录 0.可行性研究报告1引言41.1 编写目的41.2 背景51.3 定义51.4 参考资料72可行性研究的前提82.1 要求922目标102.3 条件、假定和限制112.4 进行可行性研究的方法122.5 评价.尺度123对现有系统的分析123.1 处理流程和数据流程123.2 工作负荷133.3 费用开支133.4 人员133.5 设备143.6 局限性144所建议的系统144.1 对所建议系统的说明144.2 处理流程和数据流程。154.3 改

2、进之处174.4 影响18 4.5 技术条件方面的可能性205可选择的其他系统方案206投资及效益分析217社会因素方面的可能性257.1. 法律可行性：257.2. 操作的可行性：268结论261.产品需求规格说明书1.1. 文档介绍51.1 文档目的51.2 文档范围51.3 读者对象61.4 参考文档61.5 术语与缩写解释72. 产品介绍83. 产品面向的用户群体94. 产品应当遵循的标准或规范95. 产品范围116. 产品中的角色117. 产品的功能性需求128. 产品的非功能性需求188.1 用户界面需求188.2 软硬件环境需求188.3 产品质量需求18附录A：需求建模与分析报

3、告19A.1 需求模型19实体-联系图19状态转换图20附录B：需求确认212.体系结构2.1. 文档介绍42.1.1 文档目的42.1.2 文档范围42.1.3 读者对象52.1.4 参考文献52.1.5 术语与缩写解释62.2. 系统概述72.3. 设计约束72.4. 设计策略102.5. 系统总体结构112.6子系统N的结构与功能132.7. 开发环境的配置162.8. 运行环境的配置162.9. 测试环境的配置163数据库设计3.0. 文档介绍40.1 文档目的.40.2 文档范围40.3 读者对象40.4 参考文献40.5 术语与缩写解释41. 数据库环境说明52. 数据库的命名规则

4、53. 逻辑设计54. 物理设计55. 安全性设计66. 优化77. 数据库管理与维护说明74.模块设计4.0. 文档介绍40.1 文档目的40.2 文档范围40.3 读者对象40.4 参考文献40.5 术语与缩写解释41. 模块命名规则52. 模块汇总52.1 模块汇总表52.2 模块关系图63. 子系统A的模块设计83.1 模块A-183.2 模块A-283.3 模块A-384. 子系统B的模块设计94.1 模块B-194.2 模块B-294.3 模块B-395. 其他95.测试计划1. 测试范围与主要内容42. 测试方法43. 测试环境与测试辅助工具14. 测试完成准则45. 人员与任务

5、表16. 缺陷管理与改错计划46.测试用例6.1. 测试范围与主要内容42. 测试方法43. 测试环境与测试辅助工具14. 测试完成准则45. 人员与任务表16. 缺陷管理与改错计划41.0文档介绍1.0.1 文档目的编写本文档的目的是明确本系统的详细需求，供使用单位确认系统的功能和性能，并作为软件设计人员的设计依据和使用单位的验收标准。1.0.2 文档范围该文档是借助于当前系统的逻辑模型导出目标系统的逻辑模型的，解决整个项目系统的“做什么”的问题。在这里，没有涉及开发技术，而主要是通过建立模型的方法来描述用户的需求，为客户、用户、开发方等不同参与方提供一个交流的平台。1.0.3 读者对象本文

6、档的读者是设计人员、开发人员、项目管理人员、测试人员、用户。1.0.4 参考文档软件工程实用教程 郭宁 杨一平编著 人民邮电出版社。软件工程案例教程 韩万江编著 机械工业出版社。软件工程导论，张海藩，清华大学出版社。实用软件工程，郑人杰等，清华大学出版社。1.0.5 术语与缩写解释缩写、术语解 释CSSCSS是一种格式化网页的标准方式，它对颜色、字体、间隔、定位以及边距等格式方面提供了多种属性，这些属性均可用于HTML标记符。1.1产品介绍该软件的开发意图是方便师生通讯信息的查询。本项目作为软件工程课程的训练项目提出，将学生分成若干项目开发小组进行管理。希望学生通过这个通讯录系统软件设计开发，

7、了解软件文档的相关标准和编写原则，训练并掌握软件各类文档写作的技巧，同时提高学生使用C+开发应用程序的能力。本项目的名称：通讯录系统软件。用户单位：浙江大学宁波理工学院师生。本项目的开发者：浙江大学宁波理工学院 计算机083班 林榆 陈美娇 金淑 涂小姗 江丽丽 余凯 1.2. 产品面向的用户群体本软件为通用应用型软件，使用对象是全学院师生，用户不需要任何技术背景，但应具有看懂本软件的操作规则及各项功能、操作说明的能力。该软件为用户提供了全学院师生的通讯信息，用户无需为四处打听别人的号码而烦恼，为用户节省时间和精力。该软件设计优良，界面设计精美、友好、快捷、人性化设计，后台管理功能强大、效率高

8、。使用该软件非常简单，大部分人肯定会去使用的。1.3. 产品应当遵循的标准或规范1、文档规范 a. 编写文档目前主要使用的工具是Word（项目计划文档例外，需要使用Project制作），辅助使用的工具有Visio，PowerPoint等。b. 文档务必保持段落格式整齐，文字字体，颜色，大小统一。c. 如果需要摘引html页面中的内容，不能直接从html中粘贴过来（会在word文档中留下html格式），而必须先去除格式，例如：先粘贴到notepad中。d. 务必注意中英文标点符号，文档正文一概使用中文标点符号。2、java代码命名规则与java的标准命名规则一致。对于方法名，变量名简单易懂，必要

9、时需要说名。1.4. 产品范围本软件适用于具备校园网络系统的教育界，它是比较完善的通讯录系统。由计算机来管理庞大而繁杂的学生通讯数据是非常合适的，不仅查询和修改方便，并且效率高，速度快，完全能够满足现代化公共关系活动的要求，同时也更利于实现全面办公自动化1.5. 产品中的角色角色名称职责描述班级管理员对每个班级用户进行信息管理。用户使用该软件，查找想要的同学的信息。系统管理员对用户进行信息管理及对班级管理者进行授权。1.6. 产品的功能性需求1.6.0 功能性需求分类本次设计我们采用统一的登陆入口地址，在登录模块中可以实现管理员和普通用户的登陆，管理员可以有两个账号,一个是管理员的账号,一个是

10、普通用户的账号。管理员具有修改、添加、删除、备份等权限，普通用户有查询、浏览、修改等权限，另外此系统还具有联系人生日提醒功能，如果需退出系统，只要点击退出系统连接即可退出系统。功能类别功能名称、标识符描述登陆退出login/exit实现用户的登陆，本系统采用统一的登陆入口，可以实现管理员和普通用户的登陆，在系统通讯录登陆模块里，如果不输入管理员用户名和密码，系统将默认以普通用户身份登陆，而管理员具有修改、添加、删除、除备份等权限。退出系统，只要点击退出系统连接即可。管理用户信息查询功能（1）能给出查询记录的信息；（2）如果查询的信息不存在，输出提示信息。（3）在通讯录查询模块中，用户可以通过查

11、询尽快找到希望查找的联系人，查询支持模糊查询，而且可以匹配多个字段。修改功能（1）根据需要选择所需修改的信息进行修改，修改不得违反系统的格式要求，如编号、姓名等不能置空；（2）能给出修改后记录的信息；（3）操作后选择储存文件可以使用默认文件名或用户自定义并提示修改信息保持是否成功。添加功能（1）当有信息需要录入时，根据系统的输入要求添加各项信息，每次可以添加一个或多个新的记录，新增的记录可以不存入原文件中，也可以指定文件追加内容；（2）能给出新添加记录的信息；（3）添加后提示添加是否成功。删除功能（1）根据特定信息选择所要删除的对象，如输入班级，编号，姓名等删除 （一个或多个）记录并更新内存文

12、件内容；（2）给出被删除记录的信息并提供确认机制；（3）如果没有要删除的信息，输出没有找到信息；（4）如果已经是空表，删除时应给出提示信息并返回主菜单。数据输出系统提供数据导出和打印功能，管理员可以根据需要导出或打印各种报表如个人信息报表打印、通讯录报表打印等其他功能如特殊日子的提醒、备份等系统设置在系统设置模块可以对通讯录资料的5个自定义字段随意命名，这个功能是本系统的特色，极大地提高了系统的适应各种不同需求的程度。当修改成功时，使所有的用户在通讯录的查看，修改和新建页面相应的字段名都会自动更新成系统设置的信息。用户使用浏览本模块主要完成对已有输入的通讯信息进行浏览，用户可以根据需要对信息进

13、行逐条读取或者按特定的读取条件选择列出所有记录进行浏览（每项记录只列出学号、姓名、性别、民族，班级），可选定个人信息，显示所有域（即所有详细信息）。查询在通讯录查询模块中，用户可以通过查询尽快找到希望查找的联系人，查询支持模糊查询，而且可以匹配多个字段。修改如果用户想要修改自己的号码及其他信息，可以修改。数据输出系统提供数据导出和打印功能，用户可以根据需要导出或打印各种报表如个人信息报表打印、通讯录报表打印等。其他功能如特殊日子的提醒、备份等。1.7. 产品的非功能性需求1.7.1 用户界面需求需求名称详细要求页面内容主题突出，站点定义、术语和行文格式统一、规范、明确，栏目、菜单设置和布局合理

14、，传递的信息准确、及时。内容丰富，文字准确，语句通顺，专用术语规范。导航结构页面具有明确的导航指示，且便于理解，方便用户使用。技术环境页面大小适当，能用各种常用浏览器以不同分辨率浏览，无错误链接和空链接，采用CSS处理，控制字体大小和版面布局。艺术风格界面、版面形象清新悦目、布局合理、自豪大小适宜、字体选择合理、前后一致，美观大方；动与静搭配恰当，动静效果好；色彩和谐自然，与主题内容相协调。1.7.2 软硬件环境需求需求名称详细要求操作系统Windows 2000及以上Web浏览器Internet Explorer 3.0及以上，配置TCP/IP协议数据库管理系统SQL 2000及以上，配置T

15、CP/IP协议1.7.3 产品质量需求主要质量属性详细要求正确性当有用户更改信息，系统会及时修改信息，以保证正确。健壮性系统应能监测出各种非法情况，如与设备的通信中断，无法连接数据库服务器等，以避免出现长时间等待甚至无响应。可靠性系统应保证20人可以在客户端登录，此时系统能正常运行，正确提示相关内容。性能，效率当用户登录，进行任何操作的时候，系统应该及时地进行反应，反应时间在5秒以内。易用性系统中有明确的操作说明，方便用户使用。清晰性系统中有相关的文字说明，用户可以参考。安全性系统有严格的权限管理功能，须有权限方能进入。系统需能够防止各类误操作可能造成的数据丢失、破坏。防止用户非法获取网页以及

16、内容。可扩展性系统设计要求能够体现扩展性要求，以适应将来功能扩展的需求。兼容性能在windows xp及以上版本上运行。可移植性该系统的可移植性很好，能方便地从一台电脑移到另外一台。1.7.4 其它需求需求名称详细要求硬件接口考虑到大量数据的备份等要求，需要保持与硬盘或光盘刻录机的接口。故障处理能快速恢复系统和故障处理，方便系统升级和扩充，故障恢复时间不超过5h.附录A：需求建模与分析报告A.1 状态转换图登录身份验证NY系统管理员用户班级管理员系统管理（权限分配，维护，学生管理等）班级管理YN设置密码密码错误N用学号注册重新输入账号密码信息查询修改浏览名字：姓名别名：描述：标识某位学生姓名定

17、义：姓名=8字符8位置：信息打印表名字：学号别名：描述：唯一标识某位学生定义：学号=10数字10位置：信息打印表数据字典名字：班级别名：描述：标识该学生所在班级定义：班级=0字符或数字20字符或数字=【字符|数字】位置：信息打印表名字：信息打印表别名：描述：某个学生的全部信息定义：学号+名字+班级+ 性别+民族位置：输出到打印机姓名管理员号账号密码A.2 E-R图1N系统管理员管理班级管理员姓名1M姓名性别密码N管理N账号密码MNN用户查询修改用户信息QQ号码姓名电子邮件电话号码账号管理账号附录B：需求确认提示：需求确认规程请参见SPP-PROC-RM，主要分两步：（1）需求评审，（2）需求承

18、诺。对需求的评审应当采用“正式技术评审方式”，将产生一份“需求评审报告”，规程请参见SPP-PROC-TR。在获取责任人（Stakeholders）对需求的承诺之前，该产品需求规格说明书必须先通过需求评审。需求评审报告摘要需求文档输入名称，标识符，版本，作者，完成日期，需求评审报告输入名称，标识符，评审日期，评审结论 工作成果合格，“无需修改”或者“需要轻微修改但不必再审核”。 工作成果基本合格，需要作少量的修改，之后通过审核即可。 工作成果不合格，需要作比较大的修改，之后必须重新对其评审。评审意见评审小组成员输入评审小组成员需求承诺需求文档输入名称，标识符，版本，作者，完成日期客户承诺承诺签

19、字，日期项目经理承诺承诺签字，日期.2.0. 文档介绍本文档是体系结构设计，用于描述所开发软件的总体体系框架，分析各子系统实现功能。通过本文档，开发人员将整体软件分解为多个部分，便于编程人员正对各个子系统中的单个功能进行代码实现，从而保证了软件高效的开发。同时，通过本文档对系统体系的描述，便于客户更好了解我们的开发过程，也为我们接下去的开发做指引。2.0.1 文档目的通过此文档能使开发人员对软件有进一步的系统体系结构认识，能大大提高开发人员以后对项目的编写速度和准确性，从而提高了软件开发效率。2.0.2 文档范围设计阶段：在需求报告的基础上，细分整个软件的体系结构，作为软件开发的基本模型。开发

20、阶段：在开发过程中，为数据库设计，总体结构的设计提供模板测试阶段：根据客户新的需求作相应的调整2.0.3 读者对象本文档的读者是设计人员、开发人员、项目管理人员、测试人员2.0.4 参考文献（1）张海藩,，软件工程导论，清华大学出版社，2008.02（2）陈明，软件工程学教程，科学出版社，2002.03（3）李代平，软件工程设计案例教程，清华大学出版社，2008.02（4）陈明，软件工程课程实践，清华大学出版社，2005.012.0.5 术语与缩写解释缩写、术语解 释SQL语言SQL全称是“结构化查询语言（Structred Query Language）”,SQL是一个非过程的语言，应为它一

21、次处理一个记录，对数据提供自动导航。数据窗口数据窗口是PowerBuilder的一大特色，PowerBuilder作为一种数据库前端开发工具，操作的核心是数据库中的数据。而数据窗口是一个对象，它包含了对数据库中的数据进行特定。控件控件实际上是子窗口，在应用程序与用户进行交互的过程中，控件是主要角色。2.1. 系统概述（1）本系统是通讯录系统（2）该系统的主要功能：本次设计我们采用统一的登陆入口地址，在登录模块中可以实现管理员和普通用户的登陆，然后进入系统，系统会自动判断是否为管理员或者普通用户，分别给予不同的管理权限，管理员具有修改、添加、删除、备份等权限，而一般普通用户只有查询和修改自己信息

22、的权限，如果需退出系统，只要点击退出系统连接即可退出系统。2.2. 设计约束（1）需求约束：本软件应符合国家相关软件法律的规定。本软件的操作界面应该简单易用。本软件应该能正确完成通讯录的编辑和查询。（2） 隐含约束：本软件在Windows操作系统下更加稳定，更新更方便，用户应该尽可能在Windows操作系统下使用本软件。（3）数据库命名规范 数据库表命名均遵循以下规范： 模块名_存储信息名词(多个单词用下划线分隔)。数据库字段命名遵循以下规范：存储信息名词(多个单词用下划线分隔)。数据库设计必须达到第三范式以上。（4）硬件要求硬件需要2G以上的内存软件最好能在2G内存里使用资料保存最好分阶段。

23、资料的完整，易读取。（5）接口/协议本产品以网络为基础的，使用IPV4协议（6）用户界面干净简洁，不同的权限不同的界面功能。而且在非权限用户下不可得知拥有权限的人可修改那些资料。2.3. 设计策略（1）扩展策略本软件是通讯录系统，重点在于为用户提供一个简单易用的界面实现通讯录查询的功能。在后续的版本开发中，将会根据用户的反馈增加和修改一些功能。为了确保用户可以无缝的过渡到后续版本，软件在设计的时候必须确保数据能导入到后续版本中。（2） 复用策略本软件在设计应尽可能让后续版本中重用本版本已经实现的设计，代码，文档等成果。（3） 折中策略不同用户用到的功能可能有些地方不太相同，有些用户可能会发现一

24、些不需要的功能，而自己需要的功能还没有找到。对于这种情况，本软件采取的策略是第一个版本中实现绝大多数用户的通用功能，在后续版本中针对不同的用户群完成专门化的版本。2.4. 系统总体结构2.5子系统N的结构与功能（1）所有用户功能（2）管理用户功能（2）用户功能（3）班级管理员功能2.6. 开发环境的配置类别标准配置最低配置计算机硬件Intel p4或更高的处理器内存512M以上内存256M软件WindowsXP以上的操作系统VC+ 6.0Windows2000VC+ 6.0网络通信无其它无2.7. 运行环境的配置类别标准配置最低配置计算机硬件Intel p4或更高的处理器内存512M以上内存1

25、28M软件WindowsXP以上的操作系统Windows98网络通信无其它无2.8. 测试环境的配置系统测试采用以下步骤完成测试：1 根据需求用例编写测试用例。2 手工执行测试用例。3 使用文档保存测试结果。一般来说配置测试环境可遵循下列原则：1 符合软件最低要求。测试环境首先保证能支撑软件正常运行。2 选用比较普及的操作系统和软件平台。3 营造相对简单，独立的测试环境。除了操作系统，测试机上只安装软件运行和测试必要的软件。4 无毒的环境，用强力的杀毒软件保证测试环境中没有病毒。类别标准配置最低配置计算机硬件Intel p4或更高的处理器内存512M以上内存128M软件WindowsXP以上的

26、操作系统VC+ 6.0Windows2000VC+ 6.0 3.0. 文档介绍本文档将记录产品软件的服务内容，需求对象及需求功能等内容。针对客户需求详细妥善记录整理，以便于在接下来的软件开发中，为软件开发者提供较好的标准与引导。同时也 保证了软件的产品质量，让用户在使用软件中享受软件带来的便利。3.0.1 文档目的通过此文档能够使开发人员对软件有更进一步的系统体系结构认识，为开发者在进行以后项目编写打下了坚实的奠基，通过产品体系结构报告，能使开发人员对系统有更清晰的认识，能大大提高开发人员以后对项目的编写速度和准确性，从而提高了软件开发效率。3.0.2 文档范围设计阶段：通过对客户的访谈及开发

27、组员的资料收集等手段获取信息，在整理后记录在该文档中，用于作为日后软件开发的引导和规范。开发阶段：在开发过程中，一切以需求报告为基准。软件的整体构架及各个功能模块按照需求报告中的要求开发。 测试阶段：根据需求报告中客户提出的要求，严格测试该软件在功能需求，性能需求，可靠性和可用性需求，出错需求，接口需求，约束，逆向需求这些方面是否与需求报告要求一致。3.0.3 读者对象本文档的读者是设计人员、开发人员、项目管理人员、测试人员。3.0.4 参考文献王珊 萨师煊，数据库系统概率 高等教育出版社（第四版）3.0.5 术语与缩写解释缩写、术语解 释SQL语言SQL全称是“结构化查询语言（Structr

28、ed Query Language）”,SQL是一个非过程的语言，应为它一次处理一个记录，对数据提供自动导航。ObjectObject是一些相关的变量和方法的软件集。软件对象经常用于模仿现实世界中我们身边的一些对象。对象是理解面向对象技术的关键。数据窗口数据窗口是PowerBuilder的一大特色，PowerBuilder作为一种数据库前端开发工具，操作的核心是数据库中的数据。而数据窗口是一个对象，它包含了对数据库中的数据进行特定。控件控件实际上是子窗口，在应用程序与用户进行交互的过程中，控件是主要角色。JSPJSP(Java Server Pages)是由Sun Microsystems公司

29、倡导、许多公司参与一起建立的一种动态网页技术标准。3.1. 数据库环境说明SQL20003.2. 数据库的命名规则1、文档规范 a. 编写文档目前主要使用的工具是Word（项目计划文档例外，需要使用Project制作），辅助使用的工具有Visio，PowerPoint等。b. 文档务必保持段落格式整齐，文字字体，颜色，大小统一。c. 如果需要摘引html页面中的内容，不能直接从html中粘贴过来（会在word文档中留下html格式），而必须先去除格式，例如：先粘贴到notepad中。d. 务必注意中英文标点符号，文档正文一概使用中文标点符号。2、java代码命名规则与java的标准命名规则一致

30、。对于方法名，变量名简单易懂，必要时需要说名。3.3. 逻辑设计性别照片编号姓名班级管理员管理wn出生日期管理q性别QQ号码电子邮件姓名照片N家庭电话通讯信息用户M移动电话出生日期编号J1管理通讯个人主页I姓名密码照片系统管理员出生日期编号用户ID性别4. 物理设计3.4.0 表汇总表名功能说明用户表用户具有学号、姓名、性别、民族、等属性，是保存在通讯录中用户的个人信息信息表管理员和用户的基本信息，管理员可以对其进行修改、删除、创建、管理等功能，用户可以对其只能进行查询管理员管理员分为班级管理员和系统管理员，班级管理员只能管理自己的班级其他属性和用户一样，系统管理员除了具有普通用户的属性外还拥

31、有用户ID、密码属性，用以用户及管理员的身份登陆通讯录系统对通讯录进行管理3.4.1 表A表名用户表列名数据类型（精度范围）空/非空约束条件编号vrchar否主键ID号vrchar否密码vrchar否姓名vrchar否性别char否出生日期date否照片vrchar是补充说明Aid和Apassword 属性是对系统管理员的，班级管理和普通用户一样的属性3.4.2 表B表名信息表列名数据类型（精度范围）空/非空约束条件家庭电话vrchar是移动电话vrchar是QQ号码vrchar是电子邮件vrchar是个人主页vrchar是补充说明3.5. 安全性设计数据库安全性是指保护数据以防止不合法的使用

32、所造成的数据泄露、更改或破坏。 数据库只被少数授权用户访问 ，必须提供用户ID和正确的密码。存取数据库的服务器也只能系统管理员和少数高级管理人员登录。数据库的安全策略，遵从SQL Server2000的安全策略事项。3.5.1 防止用户直接操作数据库的方法普通用户只能通过登陆自己的用户帐号及密码登陆到自己的通讯录。用户能够查询自己的信息，不能对其进行删除、修改等功能。班级管理员能对自己的班级进行管理，不能对信息进行删除、修改等功能，也只能查询信息。管理员除了具有普通用户的功能外，还可以通过管理员自己的登陆ID、密码，对用户的信息进行删除、修改等。3.5.2 用户帐号密码的加密方法数据加密是防止

33、数据库中数据在存储和传输中失密的有效手段。加密的基本思想是根据一定的算法将原始数据（术语为明文，plain text）变换为不可直接识别的格式（术语为密文，cipher text），从而使得不知道解密算法的人无法获知数据的内容。数据方法主要有两种，一种是替换方法，该方法使用密钥将明文中的每一个字符转换为密文中的一个字符。另一个是置换方法，该方法仅将明文的字符按不同的顺序重新排列。单独使用这两种方法的任意一种是不够安全的。但是将这两种方法结合起来就能提供相当高的安全程度。采用这种结合算法的例子是美国年制定的官方加密标准，数据加密标准（ata ncryption tandard,简称）。3.5.3

34、 角色与权限角色可以访问的表与列操作权限管理员用户表管理信息表管理、创建、删除、修改、查询信息用户用户表查询信息表查询信息3.6. 数据库管理与维护说明在数据库运行阶段，对数据库经常性的维护工作只要是由DBA（数据库管理员）完成的，它包括：.数据哭的转储和恢复；.数据库的安全性、完整性控制；.数据库性能的监督、分析和改造；.数据库的重组织与重改造。4.0. 文档介绍4.0.1 文档目的说明学校网站设计的过程，各应用模块的主要接口与属性、数据结构和算法。4.0.2 文档范围项目经理指定若干名开发人员从事模块的设计（一下称为模块设计人员），模块设计人员将在实现阶段编写这些模块的代码。4.0.3 读

35、者对象模块设计人员，测评人员4.0.4 参考文献软件工程导论 张海潘 编著等4.0.5 术语与缩写解释缩写、术语解 释SPP精简并行过程，Simplified Parallel ProcessSD系统设计，System Design4.1. 模块命名规则（1）用C#规则来命名方法和类，类名和应用类的模块英文名称一致。（2.）用C#规则来命名局部变量和方法的参数,因为各模块与数据库有联系，所以变量名称和数据库中表的字段名车让你更一致。（3）.接口的名称加前缀I interfaceICompare intcompare(); （4）.局部变量的名称要有意义.不要用x，y，z等等(除用于For循环变

36、量中可使用i,j,k,l,m,n). （5）所有的成员变量声明在类的顶端，用一个换行把它和方法分开.（6）采用默认的名字命名namespace，如：产品名、公司名.（7 ）建议局部变量在最接近使用它时再声明. （8）使用某个控件的值时，尽量命名局部变量. （9）把引用的系统的namespace和自定义或第三方的用一个换行把它们分开. （10）文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关连类. （11）目录结构中要反应出namespace的层次. （12）大括号要新起一行 （13）、避免容易被主观解释的难懂的名称，如方面名AnalyzeThis()，或者属性名xxK8。这样的

37、名称会导致多义性。 （14）、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。 （15）、布尔变量名应该包含Is，这意味着Yes/No或True/False值，如fileIsFound。 （16）、在命名状态变量时，避免使用诸如Flag的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用documentFlag，而是使用更具描述性的名称，如documentFormatType。（此项只供参考） （17）、即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如i或j。可能的情况

38、下，尽量不要使用原义数字或原义字符串。 （18）、可使用约定俗成的缩写使名称长度适中， （19）、在内部范围中避免使用与外部范围中的名称相同的名称。如果访问了错误的变量，则可能会产生错误结果。若变量与同一名称的关键字冲突，则必须在关键字前加适当的类型库以作标识。例如，如果有一个名为Date的变量，通过调用System.DateTime.Date只可以使用内部Date函数。 如果以上未做规定，以vs2005的C#命名规范为准。4.2. 模块汇总4.2.1 模块汇总表。子系统A网站前台模块名称功能简述用户登录给予用户登录网站客户注册客户注册成为本站会员成员搜索成员可以搜索相关信息用户列表显示所有用

39、户的信息子系统B网站后台模块名称功能简述后台用户管理普通用户的添加，删除，修改后台信息管理实现对用户信息的添加/删除/修改管理。后台模块管理修改前台显示信息客户权限管理管理人员实现对用户的分级4.2.2 模块关系图前台模块如图1：用户只要登陆后，便可以浏览到最新的消息和公告，还可以查询到通讯录中成员信息。通讯录前台用户列表成员搜索用户注册用户登录-前台功能模块图1后台功能模块图2：管理员通过后台进入管理登陆模块，当管理员成功登陆后，他就可以对自己的某些信息进行修改，并根据自己的权限对管理用户进行操作。管理员可以根据实际需要对会员信息/留言/用户/系统/数据库进行管理。管理员登录模块管理用户管理

40、信息管理首页信息设定首页功能设定客人权限设定每页显示设定搜索用户增加用户编辑会员信息删除会员信息删除用户信息按用户删除整理数据用户权限管理增加用户权限降低用户权限 后台功能模块图24.3. 子前台功能系统设计4.3.1前台功能模块-1模块名称用户登录功能描述普通用户的登录，接口与属性函数带三个参数：用户ID、用户密码、用户类型数据结构与算法采用“顺序查找”的方法补充说明查找是否有此用户时，把参数与数据库的参数做对比，是否一致4.3.2前台功能模块-2模块名称客户注册功能描述给予客户注册会员接口与属性函数带三个参数：用户ID、用户密码、用户邮箱、验证码数据结构与算法无补充说明用户密码与验证码是否

41、一致4.3.3前台功能模块-3模块名称用户搜索功能描述搜索相关用户信息接口与属性输入用户的参数数据结构与算法采用“顺序查找”的方法补充说明搜索时忽略空字符，如果没有则提示“搜索不到该信息“4.3.4前台功能模块-4模块名称用户列表功能描述显示新注册用户信息接口与属性用户ID数据结构与算法补充说明可以将选中用户拉入自己的通讯录里4.4. 子系统的后台功能模块设计4.4.1 子系统的后台功能模块-1模块名称用户管理功能描述对用户的添加，删除，修改接口与属性利用数据控件对数据库修改等。数据结构与算法无补充说明4.4.2 子系统的后台功能模块-2模块名称用户信息管理功能描述对用户信息进行删除，修改等接口与属性利用数据控件对数据库修改等。数据结构与算法无补充说明4.4.3 子系统的后台功能模块-3模块名称后台模块管理功能描述可修改前台的显示情况接口与属性数据结构与算法无补充说明4.4.4 子系统的后台功能模块-4模块名称客户权限管理功能描述对客户权限的分配接口与属性利用数据控件对数据库修改等。数据结构与算法无补充说明