标签: python documentation pep8
我一直认为main()函数(从if __name__ == '__main__'调用)不需要文档字符串,因为
main()
if __name__ == '__main__'
从python中调用函数时可以看到文档字符串,但在模块外部,但main()通常只从命令行调用(文档字符串不可访问)。
main()的想法应该足够明白,不需要任何文档。
然而,从pep8:
为所有公共模块,函数,类和方法编写文档字符串。对于非公共方法,文档字符串不是必需的,但是您应该有一个注释来描述该方法的作用。此评论应出现在“def”行之后。
哪种思路胜出?