项目指导书(第一学期).docVIP

目录 项目案例 1 应用场景 1 项目基本需求描述 1 项目运行环境 2 文档范例 4 开发文档 5 项目任务书 5 项目进展报告（每个阶段提交一份报告） 5 个人变更记录 5 用户界面检查表 6 软件总体设计文档 8 测试计划 11 测试报告 12 Java编码规范 13 1 介绍(Introduction) 13 2 文件名(File Names) 13 3 文件组织(File Organization) 14 4 缩进排版(Indentation) 15 5 注释(Comments) 17 6 声明(Declarations) 20 7 语句(Statements) 22 8 空白(White Space) 25 9 命名规范(Naming Conventions) 26 10 编程惯例(Programming Practices) 27 11 代码范例(Code Examples) 29 项目案例 应用场景 当今社会，网络技术越来越发展，可以说，二十一世纪就是网络的世纪。网络迅猛发展，势不可挡。为了实现资源共享，各式各样的网站发展迅速，各种各样的聊天工具不断更新。某公司希望通过一个聊天工具加强员工和客户之间的沟通和交流。所以制作一个聊天室势在必行。 为了实现一个更好的网络交互平台，各用户之间能够实时方便的传递信息，按照用户对系统的要求不同，可以在聊天室里实现公共聊天，也可以邀几个私交好友私聊，同时提供了两个用户之间能够传送文件。本系统是基于方便用户聊天，传递信息，共享资源，所以系统的功能主要是从以上几个模块着手。 本主要是利用JAVA语言制作一个聊天室,采用的是客户/服务器. Windows 2000及以上 TCP/IP协议 硬件： CPU: PⅢ及以上 内存：128M 硬盘：4G以上 客户机软硬件要求 软件： Windows 98/ME/2000及以上 TCP/IP协议 硬件： CPU: PⅢ及以上 内存：最少128M 硬盘：4G以上文档范例 文档 文档是计算机编程最重要的方面之一。大多数已经完成了程序编写、测试和实现的程序员获得解脱般太过着急地进入下一个项目。另一方面，程序用户抱怨文档老是不完整、不精确或者不正确。仅由程序作者调试程序的情况很少。如果程序没有输入/输出要求、如何执行程序、特定部分的代码做什么之类的详细信息，那么其他用户就很难进行程序调试。因此文档的目的就是要指导用户全面了解程序以及如何正确使用它。文档应在哪个阶段书写呢？大多数情况是在项目结束时才补上的。结果，文档就是些仓促的注解列表，再加上很少的程序运行指导。这个层次所提供的信息不充分，因此项目间的单元测试和检查的想法将有助于制定一份有效和有用的文档。 程序文档 维护计算机程序的主要原因有两个。第一个是由于我们没有能力写出完全没有错误的大型程序所产生的后果；也就是程序bug的定位和改正。错误检测在许多情况下是一个贯彻程序整个生命周期的过程。大多数错误在正式的调试和测试过程中被发现和改正，然后才认为程序完成了。第二个原因是修改现有程序以适应规范的改变。必须修改程序才能满足不断变化的用户需求，才能对程序进行完善。 要满足程序文档标准，保留用指定详细信息更新过的每个单元的注释页对程序员而言非常有用，这使得项目文档任务变得非常容易。 项目文档 文档是团队工作的一个重要方面。对于将可重用性作为首要益处的面向对象方法而言更是如此。创建者对一个通用类所作的任何修改应该立即写入文档，这样该类的用户就能注意到。应对文档进行更好的文字处理和适当归档。文档结构应该包括： 封面页，应具有项目名称、项目小组成员名字及他们的批号和注册号、提交日期、总页数（每页文档都要有页码）。 问题陈述的简要描述。 分析和设计，这需要E/R图、类定义和具有有意义字段名的表结构。 用于测试的样本数据和程序清单。 所有这些信息以及新的程序描述和任何有益于程序理解的其它注释都应整理并添加到文档文件中，这样就能对接管该程序或项目且必须重新理解其工作机制的其他人提供帮助。 参见文档范例 开发文档 项目任务书 Ja