python命名规范

作者 : 开心源码 本文共886个字,预计阅读时间需要3分钟 发布时间: 2022-05-12 共119人阅读

平时写代码杂乱无章的,自己看上去没太大影响,但是当别人来读你的代码的时候就苦不堪言,自己再去整理的时候很多问题也难以发现,代码过程中也是东一块西一块像是拼接成似的,所以这个时候规范化的代码就显得格外重要,小编在试验室的练习过程中就发现,与学校合作的公司项目要求都是在项目命名格外注重的。

  • 项目名——首字母大写、其他单词小写,多单词组合则用下划线分割
  • 包名、板块名——全用小写字母
  • 类名——首字母大写、其余字母小写,多单词采用驼峰
  • 方法——小写单词
  • 函数——若函数的参数名与保留关键字冲突,则在参数后加一个下划线,比拼音好太多
  • 全局变量——采用全大写,多单词用下划线分割

注意:

1.不管是类成员变量还是全局变量,均不使用 m 或者 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,由于Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。
4.开头,结尾,一般为python的自有变量,不要以这种方式命名
5.以__开头(2个下划线),是私有实例变量(外部不嫩直接访问),依照情况进行命名

缩写

命名应当尽量使用全拼写的单词,缩写的情况有如下两种:

  1. 常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。
  2. 命名中含有长单词,对某个单词进行缩写。这时应使用商定成俗的缩写方式。

例如:

function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。

前导后缀下划线

一个前导下划线:表示非公有。
一个后缀下划线:避免关键字冲突。
两个前导下划线:当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线:(有特殊用图)的对象或者者属性,例如init或者者file。绝对不要创造这样的名字,而只是使用它们。
注意——关于下划线的使用存在少量争议。

命名注意:

不要使用小写字母’l'(el),大写字母’O'(oh),或者者小写’i’作为单独变量名称。由于少量字体中,上诉字母和数字很难区分(比方:O和0,l和1)。

  • 参考自python学习笔记

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » python命名规范

发表回复