《写给零基础的Al Python课》-10 注释和代码风格-原创手记-慕课网

2.4 注释和代码风格

1. 注释

注释是程序中非常重要的一部分，它让代码更易读、易理解，特别是当你自己或别人需要修改代码时。注释可以解释代码的意图、功能、算法等。

在 Python 中，注释分为两种类型：单行注释和多行注释。

（1）单行注释

单行注释使用 # 符号，# 后面的内容将被视为注释，直到该行的末尾。

案例：

# 这是一个单行注释
age = 25  # 这是另一种单行注释，解释变量的作用

第一行是一个单行注释，解释代码的作用。
第二行的注释解释了 age 变量的含义。

（2）多行注释

如果你有多行注释内容需要写，可以使用三个连续的引号 ''' 或 """ 来包裹多行注释。

案例：

'''
这是一个多行注释。
可以写多行注释内容，解释代码的复杂逻辑。
'''

或者：

"""
这是另一种多行注释的写法。
它们在多个行中解释代码的工作原理。
"""

2. 代码风格

良好的代码风格能够提高代码的可读性，并帮助开发团队协作。Python 推荐使用 PEP 8 风格指南，它为代码格式提供了指导。

（1）变量命名规范

变量名应该使用小写字母，并用下划线分隔单词（例如 user_age）。
类名应该采用驼峰命名法（例如 UserProfile）。

案例：

user_age = 25  # 正确的命名方式
userAge = 25    # 不推荐（驼峰命名一般用于类名）

（2）缩进

Python 强制使用缩进来表示代码块。通常，建议使用四个空格作为一个缩进层级。

案例：

if age >= 18:
    print("你已经成年了！")

在 if 语句中，print() 的缩进表示它属于 if 语句块。

（3）空行

在函数、类定义之间留空行，可以提高代码的可读性。一般建议函数之间留两个空行。

案例：

def greet():
    print("Hello")

def farewell():
    print("Goodbye")

这两个函数之间有一个空行，提升了代码的可读性。

3. 练习

练习1：为下面的代码添加注释，解释每行代码的功能：

age = 25
if age >= 18:
    print("你已经成年了！")
else:
    print("你还未成年。")

解答：

age = 25  # 定义一个整数变量 age，表示年龄

# 判断年龄是否大于或等于 18
if age >= 18:
    print("你已经成年了！")  # 如果年龄大于等于 18，输出 "你已经成年了！"
else:
    print("你还未成年。")  # 如果年龄小于 18，输出 "你还未成年。"

解释：

第一行定义了一个整数变量 age，表示年龄。
if age >= 18: 是条件判断语句，判断年龄是否大于等于 18。
如果条件为真（即 age >= 18），程序输出 “你已经成年了！”。
如果条件为假，程序会执行 else 语句并输出 “你还未成年。”

练习2：给出一个你自己编写的代码，使用注释解释代码的作用：

假设你编写了以下代码：

num1 = 10  # 定义第一个数字变量 num1，赋值为 10
num2 = 20  # 定义第二个数字变量 num2，赋值为 20
sum_result = num1 + num2  # 计算两个数字的和，结果存储在 sum_result 变量中
print("两数之和是：", sum_result)  # 输出两数之和

解答：

num1 = 10  # 定义第一个数字变量 num1，并赋值为 10
num2 = 20  # 定义第二个数字变量 num2，并赋值为 20
sum_result = num1 + num2  # 计算两个数字的和，结果存储在 sum_result 变量中
print("两数之和是：", sum_result)  # 输出两数之和

解释：

第一行定义了 num1 变量，并赋值为 10。
第二行定义了 num2 变量，并赋值为 20。
第三行将 num1 和 num2 的和计算出来，并存储在 sum_result 变量中。
最后一行使用 print() 输出计算结果。