Pylint 报告每个没有文档字符串的函数和方法(__init__
除外)的错误。
这通常是可取的,所以我不想全局禁用它(在 pylintrc
中,或在文件级别)。
然而,在我看来,有些情况下文档字符串是不必要的,甚至是有害的。例如:
def get_foo(self, foo_id):
"""Gets foo by its id."""
return foos[foo_id]
此方法是一个简单的 getter,完全由其签名描述。必须编写文档字符串是有害的,因为如果更改方法,它会造成重复维护。
我希望能够设置(例如在 pylintrc
中)类似 docstring_threshold=3
的内容,以在函数或方法短于3行代码。有什么办法吗?
最佳答案
例如,使用 pylint 1.3.1 向您添加一行 pylintrc docstring-min-length=10
。
在生成的pylintrc pylint --generate-rcfile
文件中描述为
Minimum line length for functions/classes that require docstrings, shorter ones are exempt.
关于python - 是否可以为短函数和方法禁用 pylint missing docstring 错误?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26889188/