实验4:代码审查

一、实验题目 :代码审查

二、实验目的

1、熟悉编码风格,利用开发环境所提供的平台工具对代码进行自动格式审查;

2、根据代码规范制定代码走查表,并按所制定的审查规范互审代码。

三、实验内容

1、IDEA环境和PyCharm环境二选一;

IDEA环境

(1)预先准备在IDEA环境下实现对输入的n个整数进行排序的代码;

(2)利用Alibaba代码规约插件,对所编写代码进行自动化格式审查。

https://blog.csdn.net/larner/article/details/120894045

PyCharm环境

(1)预先准备在PyCharm环境下实现对输入的n个整数进行排序的代码;

(2)利用Code Inspections对代码进行自动格式审查。

步骤如下:

在Python中,可以使用pylint或flake8等工具来进行代码审查。

以下是一个使用flake8的例子:

首先,安装flake8:

pip install flake8

然后,在命令行中运行flake8对代码进行审查:

flake8 your_script.py

这将输出代码中潜在的问题,包括不符合PEP 8标准的代码风格和潜在的错误。

如果你使用的是IDE,比如PyCharm,可以直接在IDE中运行代码审查:

打开你的Python文件,右键点击文件名,选择"Code" -> "Run Inspection by Name..."".

输入flake8,然后按下回车键,或者选择flake8的图标。

根据需要调整flake8的规则或者添加插件来满足特定项目的代码审查需求。

这样,IDE会在下方的"Run"窗口中显示代码审查的结果。

2、2人一组根据代码规范制定代码走查表;

3、按所制定的代码走查表,小组内互相审查所编写的代码,并将审查结果填写到代码审查表中。

四、实验要求

1、预先准备的代码要求独立编写,严禁抄袭,具体排序算法可以自由选择一种;

2、利用自动化格式审查工具对代码进行格式审查,截取格式审查结果,并针对审查结果逐一进行修改;

3、制定代码走查表,提交代码格式审查表文件。

五、代码自动化格式审查结果截图

六、根据审查结果修改代码格式前后对比图(可以截取部分)
代码部分:https://gitee.com/yin-ziyu/ziyus-warehouse/blob/master/实验4 代码审查
修改之前:

修改之后:

七、实验中遇到的问题及解决方法

1:输入的整数个数n为负数或者0,导致数组大小为负数或者数组为空,无法进行排序。

解决方法:在读取n的值之后,判断n是否大于0,若不大于0,则提示用户重新输入一个大于0的整数。

2:输入的整数个数n过大,导致数组大小超过了Java数组的最大限制。

解决方法:在读取n的值之后,判断n是否超过了Java数组的最大长度限制,若超过则提示用户重新输入一个合理范围内的整数。

3:输入的整数个数n为正数但超过了实际输入的整数个数,导致数组中存在未初始化的元素,影响排序结果。

解决方法:在读取每个整数时,判断是否已经达到了n个整数,若已达到则停止读取,避免数组中存在未初始化的元素。

4:输入的整数包含非法字符或者超出整数表示范围的数字,导致无法正确读取整数。

解决方法:在读取每个整数时,使用try-catch块捕获输入不合法的异常,提示用户重新输入合法的整数。

5:排序算法性能问题,当输入的整数个数较大时,冒泡排序算法的效率较低,可能导致程序运行时间较长。

解决方法:考虑使用其他更高效的排序算法,如快速排序、归并排序等,以提高程序的运行效率。

八、代码走查

posted @ 2024-05-10 15:43  尹梓羽  阅读(9)  评论(0编辑  收藏  举报