软工作业2个人项目
作业要求
| 这个作业属于哪个课程 | 软件工程 |
|---|---|
| 这个作业要求在哪里 | 个人项目-论文查重算法 |
| 这个作业的目标 | 1、完成PSP表格。2、完成“论文查重算法”的设计并进行测试。3、代码签入Github中。 4、编写博客记录。 |
PSP表格
| PSP2.1 | 预估耗时（分钟） | 实际耗时 |
|---|---|---|
| 计划 | ||
| 估计这个任务需要多少时间 | 850 | 实际 |
| 开发 | ||
| 需求分析（包括学习新技术） | 400 | 实际 |
| 生成设计文档 | 100 | 实际 |
| 设计复审 | 100 | 实际 |
| 代码规范（为目前的开发制定合适的规范） | 80 | 10 |
| 具体设计 | 200 | 实际 |
| 具体编码 | 400 | 实际 |
| 代码复审 | 60 | 实际 |
| 测试（自我测试，修改代码，提交修改） | 180 | 实际 |
| 报告 | ||
| 测试报告 | 180 | 实际 |
| 计算工作量 | 30 | 实际 |
| 事后总结，并提出过程改进计划 | 30 | 实际 |
| 合计 | 3410 | 实际 |
设计报告
一、代码规范
命名规范：
-
使用有意义的变量名和函数名，名字全部由英文命名。
-
使用小写字母和下划线（snake_case）或驼峰命名法（camelCase）来命名变量和函数。
缩进和格式化：
- 由于使用的是Python编写，对缩进的要求非常严格。
注释和文档：
-
在关键部分和复杂代码块添加注释，解释代码的目的和工作原理。
-
对函数、变量等注释描述其输入、输出、用途等。
模块和包：
-
将代码分为模块和包，以提高可维护性。
-
使用命名空间来组织代码，避免全局变量和函数的滥用。
版本控制：
-
使用版本控制系统（如Git）来管理代码的版本，确保代码历史可追踪。
-
遵循版本控制的最佳实践，如提交有意义的注释和分支管理。
测试：
- 编写单元测试和集成测试，以确保代码的正确性。