一 代码风格:
(0)参考google代码规范:
*链接:http://zh-google-styleguide.readthedocs.org/en/latest/google-python-styleguide/
(1)缩进:
*python通过缩进对齐来表达代码逻辑:同一层次的语句必须有相同的缩进,每组这样的语句称为一个块。
*不要混合使用制表符(tab)和空格来缩进,跨平台时无法正常工作。强烈建议:每个缩进层次使用单个制表符或两个或四个空格,选择任一坚持使用,在vim中设置单个tab为四个空格。
(2)命名规则:
*类名:单词首字母大写。
*包名、模块名、局部变量名、函数名:全小写+下划线。
*全局变量:全大写+下划线。
*python文件是以.py结尾的,从技术上讲,只有在该文件需要被导入时才是必须的,但是绝大数python文件为了统一都以.py命名。一些文本编辑器通过.py后缀来检测python文件,如果没有后缀就无法使用诸如语法着色和自动缩进等功能。
(3)注释和文档:
*注释要简洁明了,并放在合适地方。
*文档:Python可通过__doc__特别变量,来动态获得文档字符串。在模块、类声明或函数声明中第一个没有赋值的字符串可以用object.__doc__来访问,object是一个模块、类、函数的名字。
(4)模块结构和布局(从上到下):
*起始行(只在unix/linux下使用,例如:/usr/bin/env python)
*模块文档(简要介绍模块功能以及重要全局变量的含义,模块外可通过module.__doc__访问这些内容)
*模块导入(推荐导入顺序:Python标准库模块、Python第三方模块、应用程序自定义模块)
*变量定义(这里定义的是全局变量,本模块中所有函数都可直接使用)
*类定义语句(类的文档变量是class.__doc__)
*函数定义语句(函数的文档变量是function.__doc__)
*主程序(根据执行模式调用不同函数,当模块是被导入时,系统变量__name__就是模块名字;模块被执行时,__name__的值为'__main__')
二 python的文档资源