内部函数(python)的docstrings是否必要？

Question

在python中,我们在开头用下划线指定内部函数/私有方法.是否应该使用docstrings记录这些功能(是否需要？)？(我的意思是正式文档,而不是帮助代码阅读器理解代码的文档)这是什么常见的做法？

Answer 1

罗,我引用PEP 8,其中明智的词应被视为法律.在这个话题上,PEP 8说:

为所有公共模块,函数,类和方法编写文档字符串.对于非公共方法,文档字符串不是必需的,但是您应该有一个注释来描述该方法的作用.此评论应出现在"def"行之后.

@ 0xc0de:当您在交互式解释器中执行帮助(function_name)时,解析的代码中将提供docstring - 它实际上是一个文字字符串,而不是"注释样式".注释只是一个注释,在解析过程中从代码中删除. (3认同)
@ 0xc0de:此外,您不需要对文档字符串使用三重双引号 - 它们只是字符串,而不是特殊语法.所以你可以使用单引号或双引号,三元组是让你在评论文本中嵌入换行符. (3认同)
嘿，谢谢。“”“是必须的吗？还是＃样式的注释还可以吗？不是我反对”“”样式的注释，而是好奇。 (2认同)