实际项目:系统维护
外观
(注意:新规范不需要这一整个部分)
假设您已经将项目交付给用户,他们希望付钱给其他人对项目进行改进。这在行业中很常见,因为 IT 项目可能存在几十年(IBM 的 CICS 产品于 1969 年首次发布,至今仍然很强大)。为了让其他人接手您的项目,您需要为他们提供完善的文档,以便他们能够理解所有内容。为此,您需要进行系统维护。
继承旧系统的人最想看到的是所有组件的简要概述,这就是我们在这里提供的。
- 不同表单如何链接在一起的结构概述
- 您将列出所有表单/模块/类并描述每个表单/模块/类的功能。
- 如果适用,请包含继承图
- 如果适用,请包含 E-R 图
- 然后,您将列出每个表单/模块/类中的不同子例程并描述每个子例程的功能,并提及任何返回值或参数
您需要包含一些您最复杂算法的示例以及您是如何构建它们的。建议您尽可能多地包含您的编码技能的证据,但在某些情况下这将非常困难,因为您将产生如此多的代码,以至于不可能完全描述所有代码。十个复杂的代码片段应该足够了。
对于每个代码片段,包括 3 个部分
- 用普通英语描述代码的功能
- 代码的伪代码概述
- 布局合理的真实代码,并在必要时添加注释
例如
普通英语
这段代码计算出一组巧克力棒的平均价格。为此,我首先应该使用 SQL 从“产品”表中查找所有巧克力棒。然后,我将把所有价格加在一起,并将总额除以巧克力棒的数量以获得平均价格。
伪代码
Items = (SELECT Product Price FROM products WHERE ProductType = ChocolateBar)
For Each Item
Count increases
TotalPrice = TotalPrice + Item.Price
Next Item
Output Average = TotalPrice / Count
真实代码
.. .. ..
对于您创建的每个模块和表单,您都应该在其背后有代码。本节将为标记者提供项目不同编码组件的概述,请牢记变量数据类型及其“位”容量,例如使用字符而不是字符串。
例如
模块“甜品表单”
此模块计算各种统计信息并为数据库中存储的所有糖果和巧克力生成报表
过程/函数 | ||||
---|---|---|---|---|
访问 | 名称 | 描述 | 参数 | 输出/返回值 |
公共 | AverageChoc | 计算巧克力棒的平均价格并输出该值 | 无 | 平均价格将打印到屏幕上 |
变量 | |||
---|---|---|---|
访问 | 名称 | 类型 | 描述 |
私有 | NumChocBars | 整数 | 存储当前库存中的巧克力棒数量 |
在这里,您为标记者提供所有代码。正如我们之前提到的,由于您使用了合理的名称、缩进和注释,因此它应该很容易理解。本节将让标记者看到所有这些努力,并在任何不完全清楚的地方进行一些注释。如果您已将其包含在技术解决方案中,请提供链接。
如果您使用程序创建了数据库表,请以设计视图显示它们,确保人们可以看到数据类型。
如果您使用 DDL,请将其复制到这里。