软件13程序设计基础实训II文档规范.doc

长沙学院 程序设计基础实训II实训报告实 训 题 目： ATM存取款系统的改进与完善 系部： 计算机科学与技术系 专 业 /年 级： 软件工程专业2012级 学 生 姓 名： 班 级： X班 学号 指导教师姓名： 职称 最终评定成绩 该处成绩为等级，不是分数2013年6月项目实训任务书课程名称：程序设计基础实训II课程编码：JX020158课程类别：专业基础必修课学分数：2学时数：32开课学期：2实训题目：ATM存取款系统的改进与完善一、已知技术参数和设计要求：银行ATM存取款系统业务描述如下：银行ATM存取款系统能为用户提供存款、取款、查询、转账和修改密码的功能。为了模拟真实的ATM业务环境，本系统必须实现存款、取款、查询、转账、修改密码以及开户的功能。用户通过开户业务在本系统开立银行账户，之后可以通过该银行账户登陆ATM系统，在系统中实现存款、取款、查询账户信息、修改密码的操作。本系统各个业务有如下注意点：（1） 登陆系统用户登陆之前，必须在登陆界面输入其银行账户，通过其正确输入的银行账户登陆系统。（2） 开户业务 要使用本系统必须首先执行开户业务开立新的银行账户，并且将此新开的银行存储于文件当中。同时，系统以身份证号码作为开户的充分条件，即一个身份证号码只能开立一次银行账户。（3） 存款业务 客户登陆系统后，选择存款业务，即可以将输入的存款金额存入相应的账户。（4） 取款业务客户登陆系统后，选择取款业务，即可以将输入的取款金额从相应的银行账户取出，但是取款金额必须大于目前的账户余额。（5） 查询业务 客户登陆系统后，可以选择查询业务，查询账户余额。（6） 转账业务 客户登陆系统后，可以选择转账业务，进行转账。注意的是转账的目的账户必须是本系统已经存在的银行账户。（7） 修改密码客户登陆系统后，可以选择修改密码业务，进行密码修改。二、各阶段具体要求：1、系统总体设计阶段（1）根据需求分析划分功能模块（2）分析并设计各个功能模块之间的关系（3）对于各个功能模块，设计相应的数据结构（必须使用链表完成全部功能）（4）设计相应的算法（必须包括排序和检索功能，且基于链表进行排序和检索）2、详细设计阶段（1）对于每个功能模块，应划分成操作层和数据层（2）对于每个操作层，应尽量考虑用户操作的简单，便捷（3）对于每个数据层，必须使用链表进行管理（4）在用链表进行管理时，必须用到链表检索和排序（5）对于数据层的操作完的数据必须保存到文件中（包括文件读、写操作）3、编码实现阶段（1）完成代码编写 （2）要求代码编写规范（不得使用全局变量、所有功能模块必须使用函数封装主函数main()的行数不得超过代码总长度的25%）（3）代码必须有相应的注释（注释行数不得少于代码的10%，函数功能、变量名、算法、重要的循环、分支都必须用注释说明）4、系统测试阶段（1）完成功能调试（2）要求完成必要的测试工作5、交付实施阶段（1）提交可正常执行的系统，程序代码（2）撰写项目实训报告书（3）要求按照文档书写规范，严格地书写文档（4）注意：不允许使用代码、图片和表格填充报告空间。代码、图片和表格在报告中的空间比重不得超过1/3。要求使用文字清晰描述代码思想和逻辑，文字描述不得少于3000字（不包含注释文字）。三、设计工作量：（1）软件设计：严格按照具体设计要求，完成问题陈述中所提到的所有需求功能。（未使用链表实现的、代码少于300行的不及格，未使用链表排序的成绩不可以为优）（2）设计报告：要求撰写不少于3000个文字的文档，详细说明各阶段具体要求。四、工作计划：安排16周时间进行实训（每周2课时），软件开发步骤如下，在第16周必须完成所有任务，实训与报告撰写同步进行；序号实践项目名称内容提要实践时数实践类型实践要求每组人数1实验1：程序架构的描述1、数据与逻辑分离2、程序架构的描述4验证必开12实验2：链表在工程中的应用1、使用链表来构造ATM机的后台数据管理2、实现常见的链表操作插入、删除、修改、遍历以及创建链表8验证必开13实验3：排序在项目中的应用1、在使用链表的基础上引导学生完成23种主要排序冒泡、选择和插入2、将这些算法结合到学生的工程应用题中8验证必开14实验4：查找在项目中的应用1、在使用链表的基础上引导学生完成12种主要查找如顺序查找2、将这些算法结合到学生的工程应用题中4验证必开15实验5：结构在文件中的应用1、讨论不同结构的设计技巧，考虑在同一项目中使用自定义结构的必要性2、考虑将复杂结构双向链表、循环链表作为解决问题的一种途径与手段4验证必开16实验6：文件操作技巧1、加强学生对文件操作的认识2、考虑将复杂结构中的相关数据通过写入文件的方法作为长期记录保存的工具3、并将此作为改进项目的手段4验证必开1五、注意事项1）提交文档课程实训任务书（每学生1份）课程实训报告（每学生1份）2）成绩评定学生成绩由指导老师负责考察评定，分为：优、良、中、及格和不及格五档。l 以下情况可以判断成绩为不及格：a、 抄袭b、 代码量少于300行c、 未使用链表d、 报告不符合规范l 以下情况不可以判断成绩为优：a、 未使用链表排序b、 使用全局变量c、 大量代码集中在主函数main()中，而不是使用函数进行合理封装d、 功能不完善，有残缺e、 代码缺乏必要的注释f、 缺课l 其他情况由指导老师综合考虑给予成绩评定l 主要考察知识点与要求：a、 链表组织数据b、 排序（基于链表）c、 链表检索d、 文件保存和读取数据e、 函数封装及调用f、 代码缩进和注释等软件工程原则基本要求g、 文档报告的章节与内容要求1、章节要求：按照软件工程的原则，报告内容共分5章。分别为：需求分析、概要设计、详细设计、代码与实现、测试。按照内容完整性的基本要求还应该包括：摘要、关键字、目录，以及参考文献、致谢、附录等内容。2、章节内容：1）需求分析：从技术人员的角度去尝试理解用户的需求。并将其描述出来。对初学者来说描述需求的方式可以使用结构图、关系图等图形。对于面向对象的项目，但我们推荐使用UML中的用例图。业务用例图用于业务建模，帮助理解和发现需求，描述对于所服务的客户能提供什么服务功能及如何运作起来的，即所谓的业务流程。系统用例图描述某一个待建系统有哪几类角色（使用者）和每个角色从系统能得到什么服务或要尽的职责。2）概要设计：概要设计，顾名思义，大概简要的设计，大概简要是从整体来说，不是说不准确含糊之意。对于面向对象的项目而言概要设计做以下事情：增加了一些对系统来说有用的类。确定系统功能模块。用各种图来描述用例，并用文字加以说明。用顺序图描述功能模块。对于非面向对象的项目，这一阶段至少应该明确程序的主要功能，以及实现这些功能的算法。3）详细设计：则是把概要的设计进一步的细化完善。对于面向对象的项目来说，详细设计要细致到每一个函数和类的功能。对于面向对象的项目，类图是最主要的图形，而且必须是完整的完善的。对于非面向对象的项目来说，详细设计必须详细到函数，在这部分文档中，我们希望大家能列出完整的函数列表，包括参数类型、返回值、函数名、函数的功能、程序中主要的算法等。4）实现部分：直白的说就是编码，这部分的文档请说明代码的编写过程与实现的逻辑，也就是在编码过程中如何对问题进行的考虑。当然这些考虑不是基于设计角度的而是基于编码角度的。作为报告的一部分，粘贴过多的代码是不恰当的。我们建议大家从你的代码中选择23段有代表性的代码附在文中，代码不要太长，半页足够。并使用足够的篇幅用文字加以说明。我们希望这23段代码有一定的复杂度和代表性，能充分体现出你的编码能力与水平。请注意，不要贴代码来填充文档空间，这样并不会说明你的代码水平高。如果你要包含全部代码，请将它们放到附录中。5）测试：测试部分主要是为了查找代码或者功能错误设计的。正规的写法应该是编写测试用例。对于初学者而言，如果不能编写测试用例，通常会使用屏幕截图来说明程序已经正确运行。这样做通常是想说明程序已经能够运行，并展示运行界面。但是要注意，文档的读者并不清楚你操作的输入过程，甚至看不出那些才是您的测试输入部分。如果截图，您应该加上文字说明来描述。说明输入什么，将会产生什么样的输出结果，或者发生什么样的异常状况，应该如何解决和修正等等。3、报告格式：报告格式的要求比较多也比较细致，这里我不再赘述，请参考后面的格式说明：程 序 设 计 基 础 实 训 II本页开始有页眉，页码也不同了。请不要修改页眉的内容.摘要为标题1（1级标题）（操作：选中本行样式中选择标题1）该点说明本行为标题。当本行为标题时将自动出现（三号黑体居中，段前0.5行，段后0.5行，单倍行距）摘 要（空一行）（小四号宋体，行距20磅，首行缩进2字符）。（要求300字左右）（1）用精炼、概括的语言来表达，每项内容不宜展开论证或说明，要客观陈述，不宜加主观评价；（2）结果和结论性字句是摘要的重点，在文字论述上要多些，以加深读者的印象；（3）要独立成文，选词用语要避免与全文尤其是前言和结论部分雷同；（4）摘要中不宜使用公式、图表，不标注引用文献编号。避免将摘要写成目录式的内容介绍（空1行）关键词：，（4号黑体，单倍行距，最后一个关键词后面无标点符号）（4号黑体）关键词是供检索用的主题词条，应采用能覆盖论文主要内容的通用技术词条(参照相应的技术术语标准)。关键词一般列35个，按词条的外延层次排列（外延大的在前面）。该点为下页首行的标题记号摘要页码为罗马数字目 录该行不是任何级标题（三号黑体居中，段前0.5行，段后0.5行，单倍行距）(空一行)摘 要I第1章 11.1 11.1.1 11.1.2 11.2 21.2.1 2第2章 52.1 52.1.1 52.1.2 52.2 62.2.1 6结 论7参考文献8附 录9致 谢10此目录为自动生成，一级标题为黑体四号，其余为宋体小四号。当设置好论文的所有标题后，右键点该区域，选择：更新域更新整个目录即可。该处插入的是分节符号（操作：插入分隔符下一页），以下部分开始新的页眉页脚（页码）。III程 序 设 计 基 础 实 训 II2级标题设为标题2（操作：选中本行样式中选择标题2）每章标题为1级标题，格式设为标题1（三号黑体居中，段前0.5行，段后0.5行，单倍行距）第1章 (空一行)（小三号黑体，段前0.5行，段后0.5行，单倍行距）1.1 3级标题设为标题3（操作：选中本行样式中选择标题3）注释，格式设为上标（小四号宋体，行距20磅，首行缩进2字符）1。（4号黑体，段前0.5行，段后0.5行，单倍行距）1.1.1 4级标题不设为标题4，以让目录中只出现3级目录（小四号宋体，行距20磅，首行缩进2字符）2。（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）（4号黑体，段前0.5行，段后0.5行，单倍行距）1.1.2 （小四号宋体，行距20磅，首行缩进2字符）（小五号仿宋体，单倍行距）1此注释格式参照参考文献的格式要求，按页标注注释。2此注释格式参照第7页参考文献的格式要求，按页标注注释。（小三号黑体，段前0.5行，段后0.5行，单倍行距）1.2 （小四号宋体，行距20磅，首行缩进2字符）（4号黑体，段前0.5行，段后0.5行，单倍行距）1.2.1 （小四号宋体，行距20磅，首行缩进2字符）。（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）公式、图示例公式编号为：（章数.公式序号）公式使用公式编辑器等工具编写 （1.1） （1.2）公式的编号与公式在同一行不要让图例、说明与图分成2页图例编号为：章数.图序号1-上锅筒 2-下降管 3-水冷壁 4-下锅筒5对流管束6-过热器下集箱 7-过热器管束 8-炉墙9-经济器 10-外壳 11-过热器上集箱图1.1 4型增压锅炉结构理论图 （a）始值加噪声时 （b）用离散Hopfield网络产生的访问路径 求解得的访问路径图1.2 10城市TSP计算机模拟结果表示例表编号为：章数.表序号不要让表头、说明与表分成2页表1.1 主要技术经济指标表序号名 称单 位数 量备 注1设计吞吐量万吨/年25.5粮食12万吨/年，杂货13.5万吨/年2泊位数个23码头总长度m1204陆域纵深m3075陆域面积万m25.736水域面积码头前停泊水域万m20.58船舶停靠及装卸作业水域回旋水域万m21.63（资料来源：中国船舶，2002年第6期，第20页）表1.2 各组分lgBi值序号T=1500KT=2000K组分lgBi组分lgBi1O2+5.26HO26.432HO25.26O2+6.423H2O+4.76H2O+6.18注：“+”表示重要成分，“*”表示冗余成分。（资料来源： 许成章：船舶先进技术，船舶工业出版社，2002.） 表1.3 压降损失计算结果 Pa换热器 热边压降损失 冷边压降损失初级 2974.37 2931.52次级 2924.65 3798.76（资料来源：/edoas/website18/info8378.htm;）此处插入了分页符，保证每章都另起一页（每章另起一页，三号黑体居中，段前0.5行，段后0.5行，单倍行距）第2章 (空一行)（小三号黑体，段前0.5行，段后0.5行，单倍行距）2.1 （小四号宋体，行距20磅，首行缩进2字符）1。（4号黑体，段前0.5行，段后0.5行，单倍行距）2.1.1 （小四号宋体，行距20磅，首行缩进2字符）2。（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）（4号黑体，段前0.5行，段后0.5行，单倍行距）2.1.2 （小四号宋体，行距20磅，首行缩进2字符）（小五号仿宋体，单倍行距）1此注释格式参照第7页参考文献的格式要求，按页标注注释。2此注释格式参照第7页参考文献的格式要求，按页标注注释。（小三号黑体，段前0.5行，段后0.5行，单倍行距）2.2 （小四号宋体，行距20磅，首行缩进2字符）（4号黑体，段前0.5行，段后0.5行，单倍行距）2.2.1 （小四号宋体，行距20磅，首行缩进2字符）。（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）（小4号黑体，段前0.5行，段后0.5行，单倍行距） （小四号宋体，行距20磅，首行缩进2字符）有更多的章请在此处插入分页符，并按前面的格式将各级标题设置好（三号黑体居中，段前0.5行，段后0.5行，单倍行距）结 论结论放在所有的章的后面，设置为1级标题(空一行)（小四号宋体，行距20磅，首行缩进2字符）参考文献需要标志出起止页码（三号黑体居中，段前0.5行，段后0.5行，单倍行距）参考文献放在结论的后面，设置为1级标题(空一行)1 袁庆龙，候文义Ni-P合金镀层组织形貌及显微硬度研究太原理工大学学报，2001，32(1)：51-53.（连续出版物：序号 主要责任者文献题名J刊名，出版年份，卷号(期号)：起止页码）2刘国钧，王连成图书馆史研究北京：高等教育出版社，1979：15-18，31（专著：序号 主要责任者文献题名出版地：出版者，出版年：起止页码）3 孙品一高校学报编辑工作现代化特征中国高等学校自然科学学报研究会科技编辑学论文集(2)北京：北京师范大学出版社，1998：10-22（论文集：序号 主要责任者文献题名主编论文集名出版地：出