实验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、制定代码走查表,提交代码格式审查表文件。
五、代码自动化格式审查结果截图
六、根据审查结果修改代码格式前后对比图(可以截取部分)
七、实验中遇到的问题及解决方法
问题一:Flake8安装失败
问题描述:
在尝试使用pip安装Flake8时,安装过程失败。
解决方法:
更新pip:使用pip install --upgrade pip命令更新pip到最新版本。
问题二:flake8运行后报错或显示警告
问题描述:
使用flake8检查代码时,可能会遇到各种错误或警告,如语法错误、缩进问题、导入问题、未使用的变量等。
解决方法:
仔细阅读错误和警告信息:flake8会给出详细的错误和警告信息,包括文件名、行号以及具体的错误原因。根据这些信息,定位到问题所在并进行修复。
修复语法错误:确保代码没有语法错误,如拼写错误、缺少括号、引号等。
检查缩进:Python对缩进非常敏感,确保代码块缩进一致,并且使用的是空格而不是制表符(Tab)。
查看flake8的文档:flake8的文档包含了所有可用的错误代码和警告代码的详细说明。查看文档来了解每个错误和警告的具体含义以及如何解决它们。
八、代码走查表