写的代码多了难免出现写法不一致的情况, 在这里记录一下规范自己的写法.

命名

文件命名采用 _ 或者 - 拼接多个单词, 尽可能短的情况下表达这个文件的作用

隐藏文件用 __ 或者 . 作为开头

类名首字母大写

常量全大写

变量全小写, 同时声明类型和作用范围

注释

Python 文件夹注释: __init__.py

对于代码行的注释用行注释, 函数和类等用块注释 (多行注释)

代码

判断语句中, 简单逻辑写上面, 复杂逻辑写下面 (else)

善用短路, 简化代码 (可读性会更差点, 但自己看着舒服)

尽量减少循环使用的次数

适当加空格和换行. 一般情况在西文符号右边紧跟一个空格, 写代码时符号左右各一个空格.

习惯性使用格式化以保证前后统一

引号

对于支持单引号的语言能用单引号的尽量不用双引号

单引号中不会解析变量和转义, 速度比双引号更快

尽量保持整体的一致性, 避免出现单引号和双引号混用