Python Docstrings与自我注释代码

时间:2018-11-28 09:06:13

标签: python comments dry docstring

许多人坚持认为我们应该为Python中的每个类和方法编写一个文档字符串,而在其他语言中,建议似乎是使用精心选择的方法名称以避免注释,这使我感到困惑。我的首选是简单地使用好的方法名称,因为文档字符串常常显得多余。

我知道IDE会使用该文档字符串进行提示,但是如果我不需要该字符串,那么我看不出重点。我只会做自己的事,但是当我参与教育时,我觉得我应该在这件事上传递好的建议。

作为一个例子,如果我有一个这样定义的函数:

def int_to_bin_string(i):
    ...

我看不出有任何理由添加描述其功能的文档字符串。实际上,这似乎违反了DRY的原理。

请问见识?

0 个答案:

没有答案