實驗四——代碼審查
一、實驗題目 :代碼審查
二、實驗目的
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

浙公網安備 33010602011771號