在Python中,我们用以下划线开头来指定内部函数/私有方法。这些函数是否应该使用文档字符串进行记录(是否必需?)? (我的意思是正式文档,而不是帮助代码阅读者理解代码的文档)这方面的常见做法是什么?
瞧,我引用自PEP 8 http://www.python.org/dev/peps/pep-0008/,其中的明智之言应该被视为法律。针对这个话题,PEP 8 说道:
- 为所有公共模块、函数、类和
方法。文档字符串对于非公共方法不是必需的,但是您
应该有一个注释来描述该方法的作用。这条评论
应出现在“def”行之后。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)