简而言之:有长的和短的两种字符串文档。

    文本应该用一个动词 (“return”) 而不是 “returns” 这样的描述。

    • 以开始
    • 换行写一句总结的话,以?或者!或者.结尾。
    • 空一行
    • 在与第一行对齐的位置开始写剩下的注释
    1. This comment serves to demonstrate the format of a docstring.
    2. by a single space.

    一个函数必须有一个字符串文档,除非它符合下面的所有条件:

    • 非公开
    • 很短