主要记录阅读《Python 风格指南》的一些笔记。
风格规范
- 不要在行尾加分号, 也不要用分号将两条命令放在同一行；
- 每行不超过80个字符, 如果要连接超过80字符的行，用额外的圆括号将其隐式地连接起来；
- 顶级定义（函数或者类定义）之间空两行, 方法定义之间空一行；
- 文档字符串：文档字符串即包，模块，类或函数中作为注释文档的语句。通常以三重双引号”””包围，格式：首行为概述，接着空一行，下面是详细文档。其中：模块的文档字符串需包含许可样版；函数和方法的文档字符串应包含args，returns，raises；类的文档字符串应包含类的说明及公共属性attributes的说明；
- 注释应以#开头（包含多行注释），且注释应离开代码两个空格。技巧性部分或复杂部分需注释，但不要描述代码，假设看代码的人比你更懂Python；
- 如果类不继承其他类，则显式集成object类；
- 避免在循环中使用+来累加字符串。如果有需要，用list.append来替代；
- 为临时代码使用TODO注释；
- 即使是打算作为脚本的文件也应该是可导入的，且导入时不应导致脚本主程序运行，应将主功能放在main()中。
- 命名：module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.
参考资料：