实验四：代码审查

一、实验题目 ：代码审查

二、实验目的

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. 代码风格不符合项目规范
   问题：编写的代码没有遵循项目或团队的编码风格规范。
   解决方法：在PyCharm中配置代码风格设置，以符合团队的编码规范。可以在File | Settings | Editor | Code Style中进行配置，并为不同的语言选择或创建相应的代码风格。
2. 代码中存在语法错误
   问题：代码中存在语法错误，导致无法运行。
   解决方法：利用PyCharm的实时语法检查功能，它会在编辑代码时即时高亮显示错误，并提供快速修复选项。
3. 缺少必要的代码注释
   问题：代码注释不足，影响代码可读性。
   解决方法：开启PyCharm的“Inspection”功能（File | Settings | Editor | Inspections），它会检查代码中的潜在问题，包括缺少注释，并提供修复建议。
4. 代码审查流程不明确
   问题：缺乏明确的代码审查流程，导致代码质量控制不严格。
   解决方法：在团队中建立代码审查流程，利用PyCharm的“Git Integration”功能来支持Pull Request的审查。确保每个成员都遵循相同的审查标准。
   八、码云
   https://gitee.com/bian-weihan/sort/issues/I9OATY