一、实验题目 :代码审查
二、实验目的
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、制定代码走查表,提交代码格式审查表文件。
五、代码自动化格式审查结果截图
使用IDEA并且进行审查发现代码书写有五个问题
六、根据审查结果修改代码格式前后对比图(可以截取部分)
1.缺少作者的注释信息,通过学习发现之所以要求注释作者信息是因为可以帮助开发人员更好地组织和管理代码,提高代码的可读性和可维护性。
2.不要使用行尾注释,应该使用java方法的注释,但是通过搜索发现可以不提醒该类错误,见七.3.a
3.在if/else/for/while/do语句中必须使用大括号,即使只有一行代码。同样可以忽略错误,见七.3.b
七、实验中遇到的问题及解决方法
1.代码修改很长时间运行依旧不成功
解决方法:通过搜索发现点击红色电灯泡可以辅助并且提示修改,最终使程序顺利进行实现功能。
2.没有链接里相应的alibaba
解决方法:尝试了带有后缀的功能,最终选择相似的,后缀不同但是作用相同。
3.a.行尾注释被提醒但是不影响代码的运行,说明行尾可以注释只是不符合java的规则。
解决方法:通过百度搜索发现这个提示可以被取消,通过setting取消该提示。如下图
b.出现上述六.3提示时同样想消除提示
解决方法:百度搜索,步骤与上述解决方法路径大致一致。具体如下图
4.问题中unused import statement的
解决方法:点击file下有invalidate caches/restart选项进行解决
八、代码走查表
代码走查表如下图
九、代码链接