在 Python 代码中查找冗余注释
项目描述
flake8-评论
报告 python 代码中的冗余注释。
一个坏评论的例子:
# create user
user.create(force=True)
在此示例中,注释提供的信息甚至比代码本身还少。因此,您可以安全地删除评论而不会丢失任何信息。目标是减少信息冗余,只在代码中留下真正重要和有用的内容。
安装
python3 -m pip install flake8-comments
用法
检查插件是否已添加到您的 flake8 中:
$ python3 -m flake8 --version
3.7.7 (flake8-comments: 0.1.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.6.7 on Linux
如果您在前面的命令输出中没有看到flake8-comments,请检查flake8并flake8-comments安装在同一个解释器中。
如果一切正常,运行flake8:
python -m flake8 example.py
类似项目
还有一些针对清理评论的好 flake8 插件:
- flake8-eradicate检测注释掉的代码。
- flake8-todos控制 TODO 注释的一致性。
- wemake-python-styleguide有一些针对评论的检查,比如是否有空评论、太多
noqa,no cover、坏 shebangs。
项目详情
关
flake8_comments -0.1.2-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 42250cb4a51dc59e6db25f1291cfb16b78ea233f72dac32a5bc7b09c691235ea |
|
| MD5 | 7e70cffc40302c3f018704026c7b2a00 |
|
| 布莱克2-256 | 9b324e4ad1131cf7d2aff04f6dbce80c74a2a39ac290acf4870d343879e5b2bf |