python的程序基本风格

注释：简洁明了的说明对于程序的维护还是比较重要的

 

文档：通过__doc__特别变量，动态获得文档字符串，在模块、类声明、函数声明中第一个没有赋值的字符串可以用属性obj.__doc__来访问，obj为模块、类、函数的名字。

 

缩进：比较流行的缩进方式是，四个空格或者制表符Tab，代码若存在跨平台，由于不同的文本编辑器对Tab的设置不一样，所以尽量不使用Tab。

 

选择标识符名称：定义简短好理解的变量名、模块名是个好习惯。

 

模块结构和布局：

(1) 起始行：通常在unix/linux下使用

(2) 模块文档：介绍模块功能及其他说明性字串，模块外通过module.__doc__访问

(3) 模块导入：import导入当前模块所需的其他模块

(4) 变量定义：一般在这定义全局变量，若非必须，尽量使用局部变量代替全局变量

(5) 类定义：当模块导入时class语句被执行，类也会被定义，类文档变量是class.__doc__

(6) 函数定义：此处定义函数通过module.function()被外部访问，当模块导入时def语句会被执行，函数会被定义，函数文档变量是function.__doc__

(7) 主程序：本模块被导入或直接执行都会调用代码，一般主程序不会写功能性代码，都是调用本程序中的各个函数

 

#!/usr/bin/env python                        (1) 起始行

“this is a test module”                     (2) 模块文档

import sys                                          (3) 模块导入

import os

debug=True                                       (4) 变量定义

 

class Fooclass (object):                   (5) 类定义

        “Foo class”

        pass

 

def test():                                               (6) 函数定义

        “test function”

        foo=Fooclass()

        if debug:

                  print ‘ran test()’

 

if __name__==’__main__’:               (7) 主程序

        test()

 

__name__指示模块如何被加载：

如果模板是被导入，__name__的值为模块名字；

如果模块是被直接执行，__name__的值为’__name__’