首页 > 其他分享 >实验四-代码审查

实验四-代码审查

时间:2024-05-14 09:56:34浏览次数:13  
标签:审查 查表 代码 实验 PyCharm 格式 flake8

一、实验题目 :代码审查

二、实验目的

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

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

六、根据审查结果修改代码格式前后对比图

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

Python代码审查(code review)是软件开发过程中的一个重要环节,它有助于发现潜在的问题、改进代码质量、提高代码的可读性和可维护性。

问题:w292 no newline at end of line

w292代码最后一行没有添加换行符,只需要在代码末尾换行(回车)即可。

问题:e902 filenot found error

e902没有在路径和名称之间加斜杠

问题:代码结构复杂、难以阅读和维护。

解决方法:

(1)使用有意义的变量名和函数名。

(2)将复杂的逻辑拆分成多个简单的函数或类。

(3)使用空行和缩进来组织代码结构。

(4)遵循SOLID原则等设计原则来提高代码的可维护性。

标签:审查,查表,代码,实验,PyCharm,格式,flake8
From: https://www.cnblogs.com/wangqingqing2/p/18190612

相关文章

  • idea拉取代码认证失败重新登录
    一、背景在更改了github登录密码后,在本地idea的代码无法正常拉取,显示认证失败却没有弹出重新认证入口。二、目标idea在认证失败之后能够自动弹出认证窗口,进行重新认证。三、实现1、先删除存留在本地的github普通凭据,路径在控制版面→用户账户→凭据管理器下的管......
  • 使用`forEach`方法前后的代码逐步简化过程
    简化前的完整循环代码首先,我们使用传统的for-each循环遍历HashMap:importjava.util.HashMap;importjava.util.Map;publicclassForEachExample{publicstaticvoidmain(String[]args){HashMap<String,Integer>map=newHashMap<>();map.put(......
  • 马尔可夫转换MSVAR模型预测资产收益率时间序列可视化分析|附数据代码
    原文链接:https://tecdat.cn/?p=36166原文出处:拓端数据部落公众号在现代金融市场中,资产收益率序列的预测一直是投资者和金融机构关注的焦点。资产收益率的波动不仅反映了市场的风险水平,也直接影响到投资组合的表现和风险管理策略的制定。然而,金融市场的复杂性和不确定性使得资产......
  • win32下汇编代码结构学习
    通常win32下三种不同的调用模式,不同版本的编译器,对汇编出来的代码都会代理一些差别。__cdecl是默认的方式,采用外平栈。__stdcall,采用内平栈。__fastcall,因为采用2个寄存器传参,所以多于2个参数后也会用外平栈的方式。传入的第一个参数位置在ebp+8,后面依次加4个字节,即第n个参数的......
  • 代码随想录算法训练营第六天 | 242.有效的字母异位词 、349. 两个数组的交集、 202.
    哈希表理论基础建议:大家要了解哈希表的内部实现原理,哈希函数,哈希碰撞,以及常见哈希表的区别,数组,set和map。什么时候想到用哈希法,当我们遇到了要快速判断一个元素是否出现集合里的时候,就要考虑哈希法。这句话很重要,大家在做哈希表题目都要思考这句话。文章讲解:https://program......
  • QT开发工具QTCreator设置格式美化,代码补全提示
    工欲善其事,必先利其器:下面介绍如何配置格式美化功能(1)先下载:astyle.exe (2)编辑astyle.astylerc点击Apply->OK (3)帮助 重启软件:测试效果 格式化化后: ......
  • 实验四代码审查
    目录一、实验题目:代码审查二、实验目的三、实验内容四、实验要求五、代码自动化格式审查结果截图六、根据审查结果修改代码格式前后对比图(可以截取部分)七、实验中遇到的问题及解决方法八、代码走查表九、有关链接一、实验题目:代码审查二、实验目的1、熟悉编码风格,利用开发环......
  • vscode新建html文件并快速生成标准的html代码
    1.打开vscode,点击OpenFolder2.选择目标文件夹,新建一个扩展名为.html的文件:3.在第一行输入!(英文状态下),按tab键,新建成功。界面如下图所示:......
  • 实验四—代码审查
    一、实验题目:代码审查二、实验目的1、熟悉编码风格,利用开发环境所提供的平台工具对代码进行自动格式审查;2、根据代码规范制定代码走查表,并按所制定的审查规范互审代码。三、实验内容1、IDEA环境和PyCharm环境二选一;IDEA环境(1)预先准备在IDEA环境下实现对输入的n个整数进行......
  • 以MIT实验Turtle Graphcis为例,探讨底层实现和复用相关
    ​在我们软件构造实验中,包含了MIT的原实验TurtleGraphcis的任务,接下来我就在完成这一实验过程中的思考谈谈个人关于底层实现和复用相关的观点。​ MIT的原实验页面链接为http://web.mit.edu/6.031/www/fa18/psets/ps0/,通过阅读页面我们可以了解这一实验的目的。简要来......