Python 编码风格和文档

• Python 代码块通常缩进 4 个空格，因为 Python 解释器视制表符和空格是不同的字符，所以尽量避免使用制表符

• 标识符命名要有意义

  • 类应该是首字母大写的单数名词（例如：Date）。当多个单词连接起来形成一个类的名字时，他们应该遵循所谓的“骆驼拼写法”规则，每个单词的首字母大写（例如：CreditCard）
  • 函数，包括类的成员函数，应该小写。如果多个单词组合，应该用下划线隔开（例如：make_payment）
  • 标识某个对象的名字应该是一个小写的名词（例如：price）　
  • 传统上用大写字母并用下划线隔开每个单词的标识符代表一个常量值（例如：MAX_SIZE）
  • 以单下划线开头的标识符（例如：_secret）意在表明他们只为类或模块内部使用，而不是公共接口的一部分
  • 用注释给程序添加说明，解释有歧义或令人困惑的结构，#字符后表注释，多行注释使用三引号（"""）表示

• 我们在定义函数时最好加上说明文档：docstring. 通常以三引号字符串分隔符，以概述目的的一行为开头，接下来是一个空白行，然后是进一步的细节描述。用 help(x) 会生成与标识对象 x 关联的文档 docstring

  def scale(data, factor):
      """
      Multiply all entries of numeric data list by the given factor.
      data: an instance of any mutable sequence type (such as a list) containing numeric elements
      factor: a number that serves as the multiplicative factor for scaling
      """
      for j in range(len(data)):
           data[j] *= factor