好的代码书写规范是一个优秀程序员的必备素养,养成良好的代码书写规范无论是在不同作者之间的代码交流还是他人以及自己阅读上都颇有好处。python语言可读性很强,如果再遵守相应的代码规范,那么你的python代码将会成为佳作!
言归正传,一个好的python代码总体规范的结构布局从上到下按顺序如下:
代码注释
模块文档
模块导入
全局变量定义
类定义
函数定义
主程序
下面分别对上面的各个部分进行叙述。
1.代码注释
好的代码注释能让阅读者对代码功能一目了然,方便代码的重用和对接,对于多人协同的项目很有用处,同时对自己管理自己的代码也很有好处。
python中的注释主要有2种方式:
(1)行注释:在要注释行的开头用#标明即可,其后的整行文字代码都作为注释用
(2)多行注释:通过三引号""",或者’’'将注释文字包括在内,即可实现跨行的注释
2.模块文档
这部分主要用来描述该模块的主要功能,以及含有的类和函数名称及功能
方便调用者在第一时间了解该模块的作用,可以通过module.doc 来查看相应模块的文档,其中module对应不同的模块名。
3.模块导入
一个python文件可能会用到其他的一些库文件或者python模块,这个时候就要用模块导入了,导入相应的模块后,就可以使用相应模块的功能。用import module来导入相应的模块
4.全局变量
定义整个模块会用到的全局变量,放在这个位置,一是使得全局变量能够发挥作用(python的变量必须在使用前有定义),二是方便修改更新。
5.类的定义
现在的高级语言编程多半是基于类的,因为其功能强大,所以很多功能的实现都封装成了相应的类
6.函数的定义
定义模块中实现相应功能的函数代码
7.主程序
这部分主要是用来测试模块功能的,当模块不作为导入模块而直接执行时,就使用主程序中的代码对模块功能进行测试,否则,不运行这段代码。一般用:
if name ==‘main’:
test()
test()代表对模块相应功能进行测试的函数,函数名字也可以不是test,只要起到测试功能就可以。
您的赞助将是我不断创作的最大动力,谢谢支持!!!
如果您觉得我的文章对您有帮助,可以通过以下方式进行赞赏: