Python编码规范05-基础规范--文档字符串(docstring)

docstring规范中最基本的两点:

1、所有的公共模块、函数、类、方法,都应该写 docstring 。私有方法不一定需要,但应该在 def 后提供一个块注释来说明。

2、docstring 的结束"""应该独占一行,除非此 docstring 只有一行。

"""Return a foobar
Optional plotz says to frobnicate the bizbaz first.
"""

"""Oneline docstring"""

 

posted on 2020-03-17 19:39  麦克煎蛋  阅读(1007)  评论(0编辑  收藏  举报