python代码规范

python代码规范

1.名称

在Python开发过程中会创建文件夹/文件/变量等，这些在命名有一些潜规则（编写代码时也要注意pep8规范）。

• 文件夹，小写 & 小写下划线连接，例如：commands、data_utils等。
• 文件，小写 & 小写下划线连接，例如：page.py、db_convert.py等。
• 变量
  • 全局变量，大写 & 大写下划线连接，例如：NAME = "wxy" 、BASE_NAME = 18
  • 局部变量，小写 & 小写下划线连接，例如：data = [11,22,33]、user_parent_id = 9等。

2. 注释

• 文件夹注释
  

• 文件注释(在文件的最上方注释)

  """
  这个文件主要为项目提供工具和转换的功能，初次之外还有日志....
  例如：
  	...
  	...
  	...
  """
  
  
  ....
  

• 代码注释

3. todo

基于注释可以实现todo注释的效果，例如：

4. 条件嵌套

以后写条件语句一定要想办法减少嵌套的层级（最好不要超过3层）。

5. 简单逻辑先处理

先写出简单逻辑代码，防止嵌套过多

6. 循环

尽量少循环多做事，提高代码效率。

7. 变量和值

# 推荐
name = "wxy"
age = 19

# 不推荐
name="wxy"
age= 18

可以基于Pycharm的格式化工具来实现自动处理。

python代码规范：PEP8规范。

https://www.luffycity.com/