老万聊Python-文件中的排列与注释

老万聊Python-文件中的模块排列与注释

最近看学生用Python编的程序总感到不爽（乱而无注释），本着程序即文档的原则，对Python文件中的排列顺序及注释进行总结。废话少说先看图1：

图1

一、文件中各模块的排列顺序

1、整个文件的注释三个英文单引号或双引号进行多行注释，可以通过__doc__来调用；
2、需要引入的模块import;
3、全局变量以g_xxx来命名，但尽量避免使用；
4、函数：一定要有函数的注释；
5、类：一定要有类注释及函数的注释；
6、主函数。

二、主函数的编写

1、主函数的模板为：
if name==’main__’:
这里的代码主要为本文件中对函数和类的测试或应用，见图1示例
else :
被其它模块调用见图1示例
** **
** **

打个赌，你可以问很多Python编程者对if name==’main__’:这条语句的作用不是很了解。这在编写模块程序是非常有用，可以测试代码放在这里，当被别的模块调用时不会出现莫名其妙的输出。

** **
2、本文件的运行结果见图2

图2
3、被其它模块调用的运行结果见图3

图3
** **
三、注释的调用
在Python语言中可以通过__doc__查看文件、函数、类及类里面的函数（方法）的注释。通过__doc__可以把程序与文档进行绑定，做到程序与文档合二为一。
1、本文件的调用，见图一中if name==’main__’:下面的的代码，运行结果见图2
2、其它模块的调用见图4，运行结果见图3

图4

规范编程，多点注释，方便你我，少挨点骂。