一些注意事项

▶️前言

来公司接近一年了，虽然前半年因为一些原因并没有系统的学到些什么，但自从新总监到来之后，也算是逐渐接触到了比较正式的代码交接流程。刚好最近有空，就来总结一下这一年学到的一些东西。

🔥关于pep8

我用的IDE是VSCode，为了方便pep8的规范书写，我安装了Flake8和autoDocstring - Python Docstring Generator插件，用于识别pep8不规的地方以及规范添加注释。
参考文件

1.关于命名规范：

函数：

(1)命名不要单给一个单词，需要说明清楚这个函数是干什么的，一般是“动宾”结构。
(2)函数名称应该小写，并使用下划线分隔单词提高可读性。

2.关于注释：

给每个函数添加注释，对函数的参数及返回值进行说明。

3.关于变量：

1.在函数初始化的时候，变量的赋值应始终在执行方法之前。错误示例：

# bad
self._ui()
self.file_dialog_path = None
# good
self.file_dialog_path = None
self._ui()

2.变量名称靠左的名称用于描述，靠右的名称偏于通用名词。

cat_red = "" # Bad, less pythonic
button_save = ""

red_cat = "" # Good, more pythonic
save_button = ""

3.全局变量需要全部大写
4.如果类变量或者类初始化甚至是函数的参数中出现list类型的变量，赋初始值的时候不要赋予[],而是赋予None.因为函数和类只会被初始化一次，但运行会运行多次，所以如果一开始初始化了一个list，不管后面运行多少次，都会在之前的list不断循环添加新的值，而不会对list中的内容进行删除更新，导致值出现错误。
参考文档

def append_to_list(element, list_to_append=[]):
    list_to_append.append(element)
    return list_to_append

>>> a = append_to_list(10)
[10]
>>> b = append_to_list(20)
[10, 20]

4.关于包和模块：

包是含有__init__.py的文件夹。模块是每一个以py结尾的文件。
参考文档

1.导入模块应该分别导入放到单独的行上

# Correct:
import os
import sys
# Wrong:
import sys, os

2.导入的顺序
导入放到文件顶部，在全局变量和常量之前，按以下顺序：标准库>第三方库>本地库

5.关于类名：

类名应该遵循CapWords约定，即单词首字母大写，以大小写作为分隔。