标签： python documentation standards pep8
在python中，我们在开头用下划线指定内部函数/私有方法。是否应该使用docstrings记录这些功能（是否需要？）？ （我的意思是正式文档，而不是帮助代码阅读器理解代码的文档）这是什么常见的做法？
答案 0 :(得分：23)
罗，我引用PEP 8，其中明智的词应被视为法律。在这个话题上，PEP 8说：
为所有公共模块，函数，类和编写文档字符串 方法。对于非公开方法，Docstrings不是必需的，但是你 应该有一个描述该方法的注释。这个评论 应该出现在“def”行之后。