10 个基本的 Python 编码约定
发布人:shili8
发布时间:2023-05-14 01:02
阅读次数:47
以下是 Python 编码的基本约定:
1. 使用4个空格作为缩进,而不是制表符。
2. 每行代码长度应小于80个字符。
3. 命名变量、函数和方法使用小写字母,用下划线分隔单词。
4. 类名的每个单词首字母大写,不使用下划线。
5. 模块级别的常量,使用全大写字母,用下划线分隔单词。
6. 在 import 语句中,首选标准库模块,然后是第三方模块,最后是应用程序自己编写的模块。
7. 在一个文件的顶部使用一段注释来描述文件的内容,包括作者姓名和日期信息。
8. 在函数和方法定义之前,使用文档字符串来描述函数和方法的作用及参数说明。
9. 尽可能使用异常处理机制,避免使用 if/else 对异常情况进行判断。
10. 当使用is和is not时,应该将None与True False进行比较。
以上是Python编码的基本约定,它们有助于代码的可读性和可维护性。