Python编程规范v21
需积分: 0 23 浏览量
2022-08-08
18:01:23
上传
评论
收藏 38KB DOCX 举报
Python 编程规范 v2
执行
� 本规范使用 pylint 及对应的配置文件来进行检测，关于 pylint 的安装和配置见：
http://blog.csdn.net/lanphaday/article/details/6089902
编码
� 所有的 Python 脚本文件都应在文件头标上如下标识或其兼容格式的标识：
[python] view plaincopy
1. # -*- coding:utf-8 -*-
� 设置编辑器，默认保存为 utf-8 格式。
注释
� 业界普遍认同 Python 的注释分为两种的概念，一种是由 # 开头的“真正的”注释，另一种是
docstrings。前者表明为何选择当前实现以及这种实现的原理和难点，后者表明如何使用这个包、
模块、类、函数（方法），甚至包括使用示例和单元测试。
� 坚持适当注释原则。对不存在技术难点的代码坚持不注释，对存在技术难点的代码必须注释。但与
注释不同，推荐对每一个包、模块、类、函数（方法）写 docstrings，除非代码一目了然，非常
简单。
格式
缩进
� Python 依赖缩进来确定代码块的层次，行首空白符主要有两种：tab 和空格，但严禁两者混用。
� 公司内部使用 2 个空格的 tab 进行缩进。
空格
� 空格在 Python 代码中是有意义的，因为 Python 的语法依赖于缩进，在行首的空格称为前导空
格。在这一节不讨论前导空格相关的内容，只讨论非前导空格。非前导空格在 Python 代码中没有
意义，但适当地加入非前导空格可以增进代码的可读性。
� 在二元算术、逻辑运算符前后加空格，如：
[python] view plaincopy
1. a = b + c
评论0