昨天看了一个朋友写的代码,再次体会到了读别人写的代码是多么痛苦的一件事。。。
总结了一下,主要问题有以下几个:
1.类名、函数名、变量名等命名混乱;
2.变量名没有意义,加上没有注释,换个人走读基本等于天书;
3.写的逻辑太混乱,喜欢用一些复杂的语法,绕来绕去的,逻辑思路清奇。
第3点由于每个人思维以及对事物的理解不一致,在此不做评价。
针对第1、2两点,特此收集整理了一下python的命名规范,希望可以帮助看到的小伙伴,让代码变得更加优雅一些。
Python命名规范:
1.项目名称
首字母大写+大写式驼峰,如:ProjectName
2.模块名和包名
全部小写+下划线驼峰,如:module_name package_name
3.类名称,异常
首字母大写+大写式驼峰,如:class ClassName: ,ExceptionName
4.全局变量、常量
全部使用大写字母+下划线驼峰,如:GLOBAL_VAR_NAME,CONSTANT_NAME
5.方法名,函数名,其余变量,参数,实例
全部小写+下划线驼峰,如:method_name,function_name,instance_var_name, function_parameter_name, local_var_name
6.处理计数器外,不使用单字母命名
7.见名知义
变量名要有意义,除常见的一些简写外(如res, req, num等),尽量用全拼,通过命名可以大致猜到变量的用处
8.严禁使用关键字作为变量名
PS:python查看关键字——
import keyword print(keyword.kwlist)
暂时就这么多,欢迎大家继续补充~