flake8-comments

报告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、糟糕的shebang。