选择排序桌面检查

码云代码:https://gitee.com/yibo886/codes/0ihau3t9pj6bkfqzxcmnl93

博客园:

一、实验题目 :代码审查

二、实验目的

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

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

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

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

一. 代码审查可能遇到各种各样的问题,以下是我本次实验中发现的问题

命名规范问题:

问题:变量、函数或类的命名不符合约定的命名规范。
解决办法:参考相关的命名规范(如 PEP 8),统一命名风格,并对不符合规范的部分进行修改。

代码风格问题:

问题:代码缩进、空格、注释等方面的风格不一致或不规范。
解决办法:使用代码风格检查工具(如 'flake8')进行检查,并根据提示修改代码风格。

代码逻辑问题:

问题:代码逻辑错误、算法不正确等。
解决办法:仔细审查代码,找出问题所在,并进行修改。可以使用调试工具来帮助定位问题。

性能问题:

问题:代码性能低下,包括时间复杂度高、内存占用过大等。
解决办法:优化代码,改进算法,减少不必要的计算或内存消耗,以提升性能。

异常处理问题:

问题:缺少必要的异常处理,或者异常处理不完善。
解决办法:添加必要的异常处理,确保程序在遇到异常情况时能够正确处理并给出合适的反馈或处理。

安全性问题:

问题:存在安全漏洞或风险,如未经验证的用户输入、SQL 注入、XSS 攻击等。
解决办法:对用户输入进行验证和过滤,使用安全的 API 和库,避免直接拼接 SQL 查询字符串,对敏感数据进行加密等。

文档问题:

问题:缺少或不完整的文档,使得代码难以理解和维护。
解决办法:补充完善代码注释和文档,描述代码的功能、用法、参数、返回值等信息

安装flake时的

在使用pip install flake8安装之后 输入flake8出现提示flake8 不是可运行的程序问题(需要再你要审查代码文件夹下运行命令提示符)

上网查了很多资料 发现是flake8的安装路径没有在系统环境变量中,系统找不到flake8需要找到flake8的安装路径 把它加入到系统环境变量中

之后填写flake8的路径就可以了
代码走查表:
https://files.cnblogs.com/files/blogs/820954/233201062221-王艺博.zip?t=1715328487&download=true

posted @ 2024-05-10 15:34  不是艺博  阅读(11)  评论(0编辑  收藏  举报