python - 内部函数（python）的文档字符串是否必要？

Question

在 python 中，我们在开头使用下划线指定内部函数/私有方法。这些函数是否应该用文档字符串记录（是否需要？）？（我的意思是正式文档，而不是帮助代码阅读者理解代码的文档）什么是常见的做法？

Answer 1

瞧，我引用了PEP 8，其中明智的话应该被视为法律。关于这个话题，PEP 8 说：

• 为所有公共模块、函数、类和方法编写文档字符串。非公共方法不需要文档字符串，但您应该有一个注释来描述该方法的作用。此注释应出现在“def”行之后。