目录
一、常用命名规范
1.1、驼峰命名法(CamelCase)
1.1.1、小驼峰命名法(lowerCamelCase)
1.1.2、大驼峰命名法(CamelCase)
1.2、蛇形命名法(snake_case)
1.3、串式命名法(kebab-case)
1.4、匈牙利命名法(HN-case)
1.5、自由命名法(studly caps)
二、建议的命名方法
2.1、变量
2.1.1、普通变量
2.1.2、私有变量
2.2、常量
2.3、函数名
2.3.1、普通函数
2.3.2、私有函数
2.4、类名
2.5、模块名
2.6、包名
一、常用命名规范
1.1、驼峰命名法(CamelCase)
骆驼式命名法(Camel-Case)一词来自 Perl 语言中普遍使用的大小写混合格式,又称驼峰式命名法,是电脑程式编写时的一套命名规则(惯例),并无绝对与强制,为的是增加识别和可读性。
是指混合使用大小写字母来构成变量和函数的名字,分为小驼峰命名法和大驼峰命名法
1.1.1、小驼峰命名法(lowerCamelCase)
除第一个单词外,其他单词首字母均大写。
1.1.2、大驼峰命名法(CamelCase)
大驼峰法(即帕斯卡命名法)单词首字母均大写。
1.2、蛇形命名法(snake_case)
全由小写字母和下划线组成,单词用小写单词间用下划线连接,也称“下划线命名法”。
1.3、串式命名法(kebab-case)
各个单词之间用中划线“-”连接,又称脊柱命名法(spinal-case)、train-case。
1.4、匈牙利命名法(HN-case)
变量名依次由属性、类型、描述组成,如:int iUserName,i为int类型缩写,UserName是描述。
1.5、自由命名法(studly caps)
混杂大小写,随性……严重不建议使用此方法
二、建议的命名方法
2.1、变量
2.1.1、普通变量
变量(值会变)名必须是一个有效的标识符;
变量名不用使用Python中的保留字;
慎用小写字面l和大写字母O;
应选用有意义的词作为变量;
尽量小写, 如有多个单词,用下划线隔开即采用蛇形命名法(snake_case)命名。
i = 0
if i>0:
number = 0,
school_name= " Tsinghua"
2.1.2、私有变量
前加下划短线,其他同2.1.1
2.2、常量
常量(值不会变)采用全大写,如多个单词,用下划线隔开。
PAI=3.14
MAX_CONNECTION=100
CONNECTION_TIMEOUT=500
2.3、函数名
2.3.1、普通函数
只有一个单词时全部小写,有多个单词时采用蛇形命名法(snake_case)命名。
def function():
pass
def function_name():
pass
2.3.2、私有函数
私有函数在函数前加一个下划线,其他同2.3.1。
classPerson():
def _private_func():
pass
2.4、类名
类名使用大驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头。
class ClassName():
pass
2.5、模块名
模块用来从逻辑上组织python代码(变量、函数、类,逻辑是实现一个功能),本质是.py结尾的python文件
推荐使用蛇形命名法(snake_case)。
impor module_name
import html_parser
2.6、包名
包是用来从逻辑上组织模块的。
本质是一个目录(必须带有__init__.py文件,当包被导入时_init_.py会自动运行)
推荐使用蛇形命名法(snake_case)。