关于代码的一些随笔

Apollo笔记

1. 不要把耗费资源的代码段放在临界区内

左边的是错误的做法，右边的是正确的做法

2. Python代码检查规则

2.1 代码风格规范

1）程序规模规范

1. 每行字符<=120字符
2. 函数长度<=120行

2）语句规范

3. 不能以分号结尾
4. 一行只能写一条语句

3） 括号使用规范

5. 尽量避免冗余的括号

4） 缩进规范

6. 禁止使用Tab进行缩进，而统一使用4个空格进行缩进
7. 如下图所示

5） 空行规范

8. 文件级定义**（类或全局函数）相隔两个空行**
   类方法之间相隔一个空行

6） 空格规范

9. （）括号内均不添加空格

10. （参数列表/索引/切片）的左括号前不应该加空格

11. 逗号 分号 冒号之前均不留空格，而在他之前添加空格

12. 所有二元运算发符前后各加一个空格

13. 关键字参数或参数默认值的等号前后不加空格

7） 注释规范

14. 文件声明
    版权声明，功能和用途介绍，修改人及联系方式

15. 用docstring进行注释时
    

16. 对外接口部分必须使用docstring进行描述，对内接口视情况而定

17. 用docstring进行注释时
    docstring 使用方法
    https://www.runoob.com/w3cnote/python-docstrings.html

2.2 引用规范

18. 对于代码中的引用规范的规定
    

19. 每行只导入一个库
    按 标准库 第三方库 应用程序自有库的顺序导入，三个部分之间分别留一个空行，如图所示：
    

2.3 定义规范

1. 变量定义规范
   1）局部变量使用全小写字母，单词间使用下划线分隔
   2）全局变量必须写在文件头部
   3）常量使用全大写字母， 单词间使用下划线分隔
2. 函数的定义规范
   1） 函数的返回值
   函数返回值必须<=3个，若函数返回值>3个，必须通过各种具名的形式进行包装。
   2）函数的默认参数
   
3. 类定义规范
   1） 使用首字母大写的驼峰式命名法
   2） 对于类定义的成员 protected 成员使用单下划线前缀，private成员使用双下划线前缀。
   3）如果一个类没有基类，必须继承自Object类
   4） 类构造函数应尽量简单

2.4 异常处理规范

1. 禁止使用双参数形式或字符串形式的语法抛出异常
2. 如需自定义异常，应在模块内定义名为Error的异常基类，并且该基类必须继承自Exception，其他异常均由该基类派生而来。
3. 除非重新抛出异常，禁止使用except：语句捕获所有异常，应该使用except……：语句捕获具体异常
4. 捕捉异常时，尽量使用as语法，禁止使用逗号语法

2.2 Python编码的四个惯例

1.让模块既可被导入又可被执行

通常自定义一个main（）函数，并使用一个if语句
if 内置变量 _name_ == '_main_'

2.in运算符的使用

3.不适用临时变量交换两个值

4.用序列构建字符串