📅  最后修改于: 2023-12-03 15:12:19.607000             🧑  作者: Mango
本程序是一个命令行工具,用于检测代码中未被注释、无法解释或未定义的除数,并给出相应的提示。 当代码中出现这些问题时,程序会弹出警告提示,并返回一个包含代码片段和错误信息的markdown文本,以便开发人员更方便地进行调试和修复。
安装Python3环境;
下载并解压本程序压缩包;
在命令行中进入解压后的目录,并执行以下命令:
python3 divide_check.py your_code_file.py
其中,your_code_file.py
是待检测的代码文件名。
如果程序检测到除数问题,将会弹出警告提示,并返回一个包含代码片段和错误信息的markdown文本。文本格式如下:
# 除数问题报告
## 代码片段
这里放代码片段
## 错误信息
这里放错误信息
假设我们有以下Python代码文件test.py
:
a = 1
b = 0
c = a / b
执行以下命令:
python3 divide_check.py test.py
将会返回以下markdown文本:
# 除数问题报告
## 代码片段
```python
a = 1
b = 0
c = a / b
## 注意事项
1. 本程序仅用于检测整数和浮点数类型的除法运算;
2. 本程序依赖Python自带的`ast`模块实现。如果在Linux环境下运行时提示`ImportError: No module named '_ast'`,可能是因为`python3`命令使用了Python 2.x版本,需使用`python3.x`命令来运行本程序(x为Python3版本号)。
## 改进计划
1. 支持检测除数为变量的情况;
2. 支持检测除数为表达式的情况;
3. 支持检测除法运算的约束和正确性;
4. 实现在代码中自动添加注释的功能。