-
头部:大部分.py文件不必以#!作为文件的开始,只有被直接执行的文件中才有必要加入#!,程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始。
-
编码:# -- coding:utf-8 --
-
版权:
################################################ # NSFOCUS Corporation. All rights Reserved ##################################################
-
注释:由 # 开头的:适当注释原则,只注释原理和难点;多行注释:函数体的第一行使用三个双引号"""来定义
为每一个包、模块、类、函数(方法)写 docstrings,对于函数要说明参数args、返回值returns,可能存在的异常raises
可以通过对象的doc成员被自动提取, 并且被pydoc所用 -
空格:不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾)
-
空行:在 import 不同种类的模块间加空行;
在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔; -
长度:最大长度不得超过 80 个字符的标准,超过了请强行换行
-
命名:
项目:ProjectName,大驼峰
类、异常:由一个或多个单词连结在一起,且每个单词首字母大写ClassName
函数、模块、包:全部小写,由下划线连接各个单词 function_name;
变量:全部小写,由下划线连接各个单词 instance_var_name
常量:全部大写;避免使用全局变量,用类变量来代替;
80%的人都看过的文章
本文来自凡蜕博客(https://blog.ysboke.cn), 转载请带上地址.。