Python小白学习笔记第3课：Python编码规范（2024版）

23次阅读

共计 1873 个字符，预计需要花费 5 分钟才能阅读完成。

在上一节课中，我们完成了第一个 Python 程序，学会了如何在交互模式和命令行模式下运行 Python 代码，但距离真正的写 Python 代码还有一段距离。

为了防止写出来的 Python 代码在运行时报各种语法格式错误，我们需要先学习下 Python 编码规范。

注释最大的作用是提高程序的可读性，没有注释的程序简直就是天书，让人吐血！

注释是给人看的，Python 解释器会忽略掉注释，也就是说，注释在随源代码进入预处理器或编译时会被移除，不会在目标代码中保留也不会影响程序的执行结果。

所以说，在编码过程中，注释必不可少，Python 中有单行注释与多行注释：

# 这是单行注释
print("hello, world")  # 也可以写这里

"""
这是多行注释
在这里可以随便写
"""
print("goodbye, world")

注意：三个连续引号，其实是定义了一个字符串。因为没有变量指向，会被当做垃圾回收。

在单行注释 #后面添加 TODO 关键字，能够高亮显示注释，少量的 TODO 注释可以起到提醒的作用：

# TODO 后面要完成的功能
print("hello, world")

第一行以 #号开头的就是头部注释，也叫神奇的注释。这些神奇的注释总是出现在文件顶部，提供解释器或编码信息。

这些注释不仅仅是给读者看的，也是给操作系统看的，这些注释决定了系统将如何运行文件，常见的头部注释有两个：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
print("hello, world")

定义 #! 会去找指定路径下的 Python 解释器；定义 coding 告诉系统脚本是何编码格式。

Python 通过类型提示提供了可选的静态类型支持，执行 Python 脚本时，类型提示被视为注释，解释器会自动忽略。

类型提示使用冒号来分隔参数和变量的名称与类型，对于返回值，类型提示使用箭头 -> 分隔 def 语句的闭合括号和类型。

# int 表示整数类型
num: int = 10

# 类型提示 n 参数需要整数值，返回值是字符串
def func(n: int) -> str:
    return str(n)

Python 程序依靠代码块的缩进来体现代码之间的逻辑关系，缩进不正确会导致程序运行错误。

虽然没有明确规定缩进几个空格或者制表符，但严禁两者混用并且数目必须统一，要么都用空格缩进，要么都用制表符缩进。通常以 4 个空格或制表符（Tab 键）为基本的缩进单位，并保持所有缩进都一致。

name = " 张三 "  # 不缩进

if name == " 张三 ":
    print(" 我是 ")  # 缩进 4 个空格
    print(" 张三 ")  # 缩进 4 个空格

一行代码长度是没有限制的，但为了可读性更强，通常将一行比较长的代码分为多行显示。这时可以使用 \ 行连接符，把它放在行结束的地方，Python 解释器会将它们解释为同一行代码。

this = "\
优美胜于丑陋，\
明了胜于晦涩，\
简洁胜于复杂，\
复杂胜于凌乱，\
扁平胜于嵌套，\
间隔胜于紧凑，\
可读性很重要。"

print(this)

不过，每行代码最好不要超过 80 个字符，如果超过，建议使用小括号将多行内容隐式的连接起来，而不推荐使用反斜杠 \ 进行连接。

Python 是区分大小写的，这意味着在编写 Python 代码时，大小写字母是有区别的。所以，一定要小心不要犯大小写错误，因为它们可能会导致代码出现错误。

name = " 张三 "
Name = " 李四 "

print(name)  # 结果为：张三
print(Name)  # 结果为：李四

包 / 模块的命名规范：使用小写字母命名，如果有多个单词，则用下划线分隔。正确命名方式：lower_with_under。

类的命名规范：使用驼峰法命名，如果有多个单词，则首字母大写，私有类用下划线开头。正确命名方式：HelloWorld 和_HelloWorld。

函数 / 变量的命名规范：使用小写字母命名，如果有多个单词，则用下划线分隔，私有函数 / 变量用下划线开头。正确命名方式：lower_with_under 和_lower_with_under。

常量的命名规范：全部使用大写字母命名，如果有多个单词，则用下划线分隔，私有常量用下划线开头。正确命名方式：CAPS_WITH_UNDER 和_CAPS_WITH_UNDER。

正文完

发表至：编程

2024-01-11

0

转载说明：除特殊说明外本站文章皆由CC-4.0协议发布，转载请注明出处。

Python小白学习笔记第2课：Python运行环境搭建（2024版）

注释