http 请求
请求、返回内容里的参数命名一般是驼峰格式: problemDescription
mysql 建表:
表名:全小写,下划线连接, 如 online_problem
字段:驼峰格式, 如 isActive
python:
包名: 应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。
模块名:与包的规范同。如 mymodule, 也可以 my_module。
文件名:全小写,可使用下划线。
类名: 总是使用首字母大写单词串(Pascal命名风格)。如 MyClass。内部类可以使用额外的前导下划线。
函数&方法:函数名应该为小写,用下划线风格单词以增加可读性。如:my_example_function。
私有函数: 以 __
开头(2个下划线),其他和普通函数一样
函数和方法的参数: 总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。
普通变量: 变量名全部小写,由下划线连接各个单词。如 this_is_a_variable = 1
*注意*:
1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
全局变量(类变量,在 java 中相当于 static 变量): 大写字母,单词之间用 _
分割 , 如 COLOR_WRITE
*注意*: 应避免使用全局变量
实例变量: 以 _
开头,其他和普通变量一样。 如 _instance_var
私有实例变量(外部访问会报错): 以 __
开头(2个下划线),其他和普通变量一样。 如 __private_var
专有变量: __
开头,__
结尾,一般为python的自有变量;不要以这种方式命名普通变量,这个是保留字,要满足防御性编程需求。 如: __class__
常量:常量名所有字母大写,由下划线连接各个单词如 MAX_OVERFLOW
,TOTAL
异常: 因为异常也是一个类,所以遵守类的命名规则。此外,如果异常实际上指代一个错误的话,应该使用“Error”做后缀。