零基础学Python：编程规范

news2024/9/25 13:24:46

1. 注释

python注释也有自己的规范，在文章中会介绍到。注释可以起到一个备注的作用，团队合作的时候，个人编写的代码经常会被多人调用，为了让别人能更容易理解代码的通途，使用注释是非常有效的。
在说规范之前我们有必要先看以下Python的注释有哪些 ?

单行注释
多行注释
特殊注释

单行注释

以 # 开头， # 右边的所有东西都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用
示例代码如下：

为了保证代码的可读性， # 后面建议先添加一个空格，然后再编写相应的说明文字

多行注释（块注释）

如果注释信息很多，一行无法显示，就可以使用多行注释
要在 Python 程序中使用多行注释，可以用一对连续的三个引号(单引号和双引号都可以)
示例代码如下：

注释不是越多越好，对于一目了然的代码，不需要添加注释

特殊注释

关于代码规范

Python 官方提供有一系列 PEP（Python Enhancement Proposals）文档
其中第 8 篇文档专门针对 Python 的代码格式给出了建议，也就是俗称的 PEP 8
文档地址：PEP 8 – Style Guide for Python Code | peps.python.org
谷歌有对应的中文文档：Python风格规范 — Google 开源项目风格指南
任何语言的程序员，编写出符合规范的代码，是开始程序生涯的第一步

编程习惯的重要性

1. 可以方便排查错误
2. 方便自己看的代码
3. 便于别人看懂你的代码（团队协作）

良好的编程习惯的养成不能靠说，要靠多练，要在大量的编程中将其融入骨髓中。

一套系统应该具有统一的编程风格，任何编程风格都不可能是完美，应该从可维护性、可读性方面继续保持一种编程风格，而不要将多种编程风格混合在一套系统中，对于新手，难以理解如此多种风格的编码。
ctrl + alt + l 快速格式化代码

标识符命名规则

开发人员在程序中自定义的一些符号和名称。标识符是自己定义的, 如变量名、函数名等

标识符的规则

标识符由字母、下划线和数字组成，且数字不能开头
python中的标识符是区分大小写的

命名规则

1、下滑线命名法

用下划线“_”来连接所有的单词，比如 hello_world
1. 见名知意
2. 起一个有意义的名字，尽量做到看一眼就知道是什么意思(提高代码可读性) 比如: 名字就定义为name , 定义学生用 student

2、驼峰命名法

大驼峰式命名法（upper camel case）：

每一个单字的首字母都采用大写字母，
例如：FirstName、HelloWorld

小驼峰式命名法（lower camel case）：

第一个单词以小写字母开始；
第二个单词的首字母大写，
例如：helloWorld、firstName

注意

所有的变量名、函数名都是用下划线命名法
类名使用大驼峰命名法

Python命名规则

python中的标识符是区分大小写的
变量、函数名全部用小写与下划线
常量（配置文件变量、不修改的变量）全部用大写
类名用大驼峰命名法

关键字

什么是关键字：
python一些具有特殊功能的标识符，这就是所谓的关键字
关键字，是python已经使用的了，所以不允许开发者自己定义和关键字相同的名字的标识符
可以通过以下命令进行查看当前系统中python的关键字

输出

print() 方法用于打印输出，最常见的一个函数。
以下是 print() 方法的语法:

参数

objects -- 复数，表示可以一次输出多个对象。输出多个对象时，用分隔符分割。
sep -- 用来间隔多个对象，默认值是一个空格。
end -- 用来设定以什么结尾。默认值是换行符 \n，我们可以换成其他字符串。
file -- 要写入的文件对象。

输入

input() 函数接受一个标准输入数据，返回为 string 类型。

变量

程序就是用来处理数据的，而变量就是用来存储数据的

在 Python 中，每个变量在使用前都必须赋值，变量赋值以后该变量才会被创建
等号（=）用来给变量赋值
- = 左边是一个变量名
- = 右边是存储在变量中的值
直接使用之前已经定义的变量
变量名只有在第一次出现才是定义变量
变量名再次出现，不是定义变量，而是直接使用之前定义过的变量
在程序开发中，可以修改之前定义变量中保存的值吗？
- 可以
- 变量中存储的值，就是可以变的

变量定义之后，后续就可以直接使用了

常见错误类型

SyntaxError: unexpected EOF while parsing
语法错误，多了无法解析的符号，检查一下是否多了或者少了括号
SyntaxError: invalid character in identifier
语法错误有无效标识符，检查一下中文符号
IndexError: list index out of range
索引错误，超出索引范围，检查一下列表是否为空
TypeError: must be str, not int
数据类型错误，该数据不是正确的数据类型，比如字符串和数字直接拼接，检查一下数据类型
IndentationError: expected an indented block
缩进错误，检查一下代码的缩进是否正确
KeyError: 'fond'
键错误，字典中没有该的key对应的值，检查一下键名或者字典数据是否正确
ValueError: substring not found
值错误，输入的数据类型跟要求的不符合
NameError: name 'a' is not defined
未初始化对象，变量没有被定义
AttributeError: 'tuple' object has no attribute 'remove'
属性错误，该对象没有这个属性、方法，检查一下数据类型
SystemExit
解释器请求退出，出现在exit()函数后
IOError
输入/输出操作失败
ImportError
导入模块/对象失败，检查一下模块是否能够正常使用
UnicodeDecodeError/UnicodeEncodeError/UnicodeTranslateError
Unicode 解码/编码/转换/时的错误