Skip to main content

在 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,请检查flake8flake8-comments安装在同一个解释器中。

如果一切正常,运行flake8

python -m flake8 example.py

类似项目

还有一些针对清理评论的好 flake8 插件:

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

flake8-comments-0.1.2.tar.gz (5.3 kB 查看哈希

已上传 source

内置分布

flake8_comments-0.1.2-py3-none-any.whl (5.2 kB 查看哈希

已上传 py3