python笔记007--代码风格

来源:互联网 发布:focusky官方中文版mac 编辑:程序博客网 时间:2024/06/06 02:07

一、基本

1、注释

2、文档

可以通过__doc__特别变量,动态获得文档字串:obj.__doc__

3、缩进

4个空格

4、选择标识符名称

短+意义丰富


二、模块结构和布局

1、起始行(Unix)

2、模块文档——简要介绍模块的功能及重要全局变量的含义,模块外可通过module.__doc__来访问这些内容

3、模块导入

4、变量定义——全局变量

除非必要,要尽量使用局部变量代替全局变量

5、类定义语句

类的文档变量:class.__doc__

6、函数定义语句

函数的文档变量:function.__doc__

7、主程序

典型python文件结构#/user/bin/env python(1)起始行“this is a test module”(2)模块文档(文档字符串)import sys
import os(3)模块导入debug = true(4)(全局)变量定义class FooClass(object):
“Foo class”
pass(5)类定义 (若有)def test():
“test function”
foo = FooClass()
if debug:
print ‘ran test()’(6)函数定义(若有)if __name__ == '__main__':
test()(7)主程序














三、在主程序中放置测试代码

python标准库提供了unittest模块(PyUnit),一个测试框架。