实验四代码审查

一、实验题目 :代码审查

二、实验目的

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、制定代码走查表,提交代码格式审查表文件。

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

图1 代码检查结果图

六、根据审查结果修改代码格式前后对比图(可以截取部分)

图2 代码修改前



代码根据提示修改之后:

图3 代码修改后的结果图

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

问题1:提示是英文,看不懂,读不懂。

解决办法:利用翻译软件,拍照翻译。

问题2:由于开发软件的版本不同,在操作上有不同的步骤。

解决办法:根据以往学习的经验,自我进行多次尝试。最终蒙对了。

问题3:对于代码走查表的了解不多,难以下手。

解决办法:请教了老师和同学们,虚心请教,在指导下弄明白。

问题4:代码走查表的制定规范不清楚。

解决办法:通过听别的同学问老师,旁听了解获得指导。

问题5:代码的效率性和完美性较不完美。

解决办法:通过以往的经验,逐步改善,逐步提升,增长经验,一次更比一次强。

八、代码走查表



九、有关链接

修改前的代码:https://gitee.com/mooncirlight/TianCangCang-warehouse/blob/master/shiyansi_1.py

修改后的代码:https://gitee.com/mooncirlight/TianCangCang-warehouse/blob/master/shiyansi.py

代码走查表链接:https://gitee.com/mooncirlight/TianCangCang-warehouse/blob/master/朱华斌代码走查表.docx

posted @ 2024-05-13 22:01  CirLight  阅读(19)  评论(0编辑  收藏  举报
//雪花飘落效果 //雪花飘落效果