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