Python编程基本规范
2024-09-06 18:34:43
1、命名规范
类:类的名称一般为名词,且以驼峰形式(即每个单词首字母要大写,其余字母小写,单词之间无间隔符号)给出。
函数:一般以动词开头,函数名称要准确、简要地概括本函数的作用。函数名一律小写,如有多个单词,用下划线隔开。
变量:变量取名应有实际含义,尽量避免单个字母如m,n,i,j等,除非该变量无实际业务含义。变量名应小写,如有多个单词用下划线隔开。
常量:所有字母大写,多个单词以下划线隔开。
2、换行
函数之间空一行;
类与类外函数之间空两行;
3、注释
在代码的关键或复杂的地方,应作注释,一看便知的部分无需注释。
4、函数抽象与复用
任何两个实现基本相同的功能的代码块,应考虑将其独立成一个函数,再分别调用。
如两个代码块功能基本相同,但略有出入,则抽象的函数应考虑这种细小的差异,通过对函数设定参数来解决,使之能够适配不同情况。
5、函数耦合
函数功能应尽量单一且独立(即不依赖其他函数),尽量避免多个函数层层依赖,如A->B,B->C,C->D。
使用多个函数应多用组合,少用依赖。即不推荐A->B->C->D,推荐写成A->B,A->C,A->D。
6、是否使用类
简单的程序用Python来实现基本不需要使用类或者说面向对象编程的风格,除非需要用到面向对象的继承功能。
如果只是为了隔离一组函数与另外一组函数,也无需封装成类,写在不同的文件中,用模块来区分即可。
在Python中,类更多地是用作一种复杂的数据结构,即视作一种数据类型。
7、异常处理
复杂或涉及用户输入的程序,应考虑程序的稳健性,使之能够应对异常情况。对可能出现的代码块,如涉及用户输入
、文件读写、数据库操作的代码部分应该加上try...catch。
8、程序效率与代码量
在确保实现功能的情况下,代码应尽量精简且高效,追求简洁之美。
最新文章
- 最全的 JavaScript 知识总结
- 牛客网程序员面试金典:1.1确定字符互异(java实现)
- sql事务和锁
- C/S love自编程序
- Python入门版
- SqlServer知识点记录分享
- Linux目录结构【转】
- 【mapping】 springmvc的注解mapping无法生效的问题
- 【转载】C# Tutorial - Simple Threaded TCP Server
- hdu1087 简单DP
- css定位 浮动 伪类 margin
- 搭建dnsmasq服务器,局域网内部解析
- WinSock WSAEventSelect 模型总结
- 【AGC015E】Mr.Aoki Incubator DP
- MariaDB报错Plugin 'InnoDB' init function returned error.解决方案
- Oracle update语句更新值来自另一张表中的数据
- 关于xml的相关知识
- 微信小程序之跨界面传参
- PAT甲级 1125. Chain the Ropes (25)
- hadoop学习之yarn资源管理
热门文章
- 过滤idea一些不需要的文件和文件夹的显示,在使用svn的时候可以很方便的过滤不需要提交的文件
- System类&;StringBuilder类
- while(scanf(";%d";,&;n)!=EOF) / while(cin>;>;n)终止问题
- Spring Cloud学习 之 Spring Cloud Hystrix(流程分析)
- FOC 转子初始位置检测(图文详解)
- 基于Kubernetes服务发现机制的探讨Non Service
- [hdu4713 Permutation]DP
- [hdu1085]生成函数
- Android 组件间通信--事件驱动
- html5 canvas画云