Python代码编写规范

编码:

a) 如无特殊情况,文件一律使用UTF-8编码

b) 如无需特殊情况,文件头部必须加入#-*-coding:utf-8-*-

缩进

a) 统一使用4个空格进行缩进

引号

a) 自然语言使用双引号”….”,正则表达式使用原生的双引号r””

b) 机器标识使用单引号’’

c) 文档字符串(docstring)使用三个双引号”””…”””

空行

a) 模块级函数和类定义之间空两行

b) 类成员函数之间空一行

import语句

a) import语句应按照顺序排列,每组之间用一个空行分隔

二元运算符

a) 二元运算符两边各空一格, = -

函数的参数列表

a) 函数的参数列表中’,’逗号之后要有空格

b) 函数的参数列表中,默认值等号两边不要添加空格

c) 左括号之后,右括号之前不要加多余的空格

d) 字典对象的左括号之前不要多余的空格

换行

a) 第二行缩进到括号的起始处

b) 第二行缩进4个空格,适用于起始括号就换行的情形

docstring

a) 所有的公共模块,函数,类,方法,都应该写docstring,私有方法不一定需要,但是应该在def后提供一个块注释来说明”””…”””

注释

a) 有意义的注释 list #list

b) 比较重要的注释段,使用多个等号隔开,可以更加醒目,突出重要性

命名规范

a) 模块名称尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况

b) 类名使用驼峰(CamelCase)命名风格,首字母大写

c) 函数命名一律小写,如有多个单词,用下划线隔开

d) 变量名尽量小写,如有多个单词,用下划线隔开

e) 常量采用全大写,如有多个单词,使用下划线隔开

python 代码编写规范

一 代码编排1 缩进.4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格.2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号.换行点要在操作符的后边敲回车.3 类 ...

Python代码编写规范,你真的会吗?

前言 本文的文字及图片来源于网络,仅供学习.交流使用,不具有任何商业用途,版权归原作者所有,如有问题请及时联系我们以作处理.作者:yangjiajia123456  最近两年的工作都是和运维相关,有时 ...

Python代码编码规范

目录 1. Introduction 介绍 2. A Foolish Consistency is the Hobgoblin of Little Minds 尽信书,则不如无书 3. Code la ...

.NET代码编写规范 整理

.NET代码编写规范 整理 .NET代码编写规范 - [ASP.NET] 2009-02-26 | Tag: 版权声明:转载时请以超链接形式标明文章原始出处和作者信息及本声明 http://lensp ...

代码编写规范说明书(c#.net与asp.net)

代码编写规范说明书(c#.net与asp.net) 目 录1 目的2 范围3 注释规范3.1 概述3.2 自建代码文件注释3.3 模块(类)注释3.4 类属性注释3.5 方法注释3.6 代码间注释4 ...

Java学习---Java代码编写规范

编码规范 1 前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程.系统继承的其它资源中的源程序也应按此规 ...

PHP|PHP之代码编写规范

PHP之代码编写规范 一.编辑器设置 1.使用Tab缩进(四个空格),不要直接使用空格 2.文件编码格式 二.命名设置 1.公共库名称空间 2.变量命名 2.1.所有字母都使用小写 2.2.首字母根据 ...

Java代码编写规范

编码规范 1 前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程.系统继承的其它资源中的源程序也应按此规 ...

Java代码编写规范(不是标准规范,自行整理,无须纠结)

最近回过头来给以前的项目增加功能,发现之前写的注释非常不全,代码也非常的不整洁,有些地方写的''窝七八烂的,看着很不舒服:又恰好经理最近也经常跟我提起代码规范,我们就讨论了一下代码规范的重要性和必要性 ...