内部函数（python）的文档字符串有必要吗？

Question

在Python中，我们用一个下划线开头来表示内部函数或私有方法。那这些函数需要用文档字符串来写说明吗？（我指的是正式的文档，不是为了帮助阅读代码的人理解代码的那种）通常大家是怎么做的呢？

Answer 1

我来引用一下来自PEP 8的内容，这些智慧的话应该被视为规则。在这个话题上，PEP 8 说：

• 为所有公开的模块、函数、类和方法写文档字符串（docstrings）。对于不公开的方法，虽然不需要文档字符串，但你应该写一个注释来描述这个方法的功能。这个注释应该放在“def”行之后。