实验四——代码审查

一、实验题目 ：代码审查

二、实验目的 

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时出现no module named venv

  解决办法：1.可能是安装路径不对，将其放在代码运行路径下；

         2.可能是配置文件时粗心填写Tools setting，注意空格数量。

  问题二：看不懂flake8给出的错误

  解决办法：使用屏幕翻译或者上网搜寻解决

代码走查表：

https://files.cnblogs.com/files/blogs/821030/zx%E4%BB%A3%E7%A0%81%E8%B5%B0%E6%9F%A5%E8%A1%A8.zip?t=1715327144&download=true

码云：

https://gitee.com/zchangxing/zhang-xians-code