ari*_*ari 7 python documentation pep8
我一直以为main()
函数(从中调用if __name__ == '__main__'
)不需要docstring,因为
从python中调用函数时可以看到main()
文档字符串,但在模块外部,但通常只从命令行调用(文档字符串不可访问).
main()
应该充分理解它的想法,它不需要文档.
然而,从pep8:
为所有公共模块,函数,类和方法编写文档字符串.对于非公共方法,文档字符串不是必需的,但是您应该有一个注释来描述该方法的作用.此评论应出现在"def"行之后.
哪条思路胜出?