Python3.x那些事儿：[24]文档字符串

这里讲一下文档字符串的一些约定俗成的编写方式。

第一行应该是一个简短的精确的关于这个对象的总结。为简便起见，一般都不显式陈述对象的名字或类型，因为这些都可以通过其他方式来获取到。

这一行要以一个大写字母开头，以一个英文句点结束。

如果文档字符串有多行的话，那么第二行要是空白行，隔开第一行的总结和下面的描述。下面的描述可以是关于函数的调用规则和它的副作用等等。

Python对于用三引号括起来的多行字符串是不去除中间的空白和缩进的，因此如果你自己要处理文档字符串的话，要手动处理其中的空格和缩进。一般都是把第一行字符串之后的第一次出现的非空行字符串的缩进作为所有文档字符串的缩进量，因为第一行字符串会有三个引号，因此它们的缩进并不能代表文档字符串的缩进。于是所有行的缩进部分的空格都可以被去除掉，缩进少于规定缩进量的是不应该出现的，但是如果出现了，那么改行的头部所有空白都应该被去除。空格的数量应该是在把其他空白字符转换为空格的情况下计算出来的，例如，一个tab字符应该是等价于8个空格。