Python的编码风格与文档字符串

代码风格

Python社区有自己的代码风格建议，遵守它可以使代码更加易读易懂。

• 用四个空格做缩减，不用制表符
• 每行不超过79个字符
• 函数和类之间，以及大块的代码之间用空行隔开
• 如果可能，把注释放于独立的行
• 使用文档字符串
• 操作符周围，以及逗号之后使用空格，但是不要在直接在括号两边使用空格 a = f(1, 2) + g(3, 4)
• 类和函数的命名风格一直保持一致，惯例是，驼峰方式 CamelCase用于类，下划线方式 lower_case_with_underscores用于函数和方法，方法的第一个参数总是命名为self
• 如果代码需要在国际背景下使用，则不要使用其他编码，默认的UTF-8就可以，同时不要使用ASCII之外的字符定义标识符

文档字符串

文档字符串用于作为对某个对象的描述，起到注释，说明的作用，使代码更加易读，可维护。对象可以是模块，类，方法，函数。

声明文档字符串

通过在对象的首部位置定义一个字符串字面量表达式的方式定义文档字符串，不仅限于"""多行字符串，普通的'或"也是可以的。

文档字符串首行建议是简明扼要的一句关于对象的总结，随后如果还有其他内容，则紧接着空一行，再开始对对象做详细的描述。

>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything.
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

    No, really, it doesn't do anything.

访问文档字符串

一些工具会自动获取文档字符串获取对象的注释，说明信息。如需在代码里访问文档字符串，可以通过object.__doc__属性访问。