5、Python代码规范详解:缩进规则与注释写法避坑指南

适合人群:零基础自学者 | 编程小白快速入门
阅读时长:约4分钟

文章目录

  • 一、问题:Python缩进规则有哪些?如何避免常见错误?
    • 1、例子1:缩进体现代码层级性
    • 2、答案:
      • (1)Python缩进的核心规则
      • (2)按 tab 键使用缩进代码
  • 二、问题:如何规范编写Python注释?单行与多行注释的正确写法是什么?
    • 1、例子1:简单使用单行注释和多行注释
    • 2、例子2:实际开发中的注释规范
    • 3、答案:
      • (1)注释是什么
      • (2)使用注释
      • (3)⚠ 新手注意
  • 三、动手试一试

一、问题:Python缩进规则有哪些?如何避免常见错误?

1、例子1:缩进体现代码层级性

层级性:观察缩进的空格数量,体会代码的层级关系

# Python
class CarFactory:	# 本行代码没有缩进,这是第1层级
	def create_car(self,brand):	# 本行代码缩进4个空格,这是第2层级
		if brand == "奔驰" :		# 本行代码缩进8个空格,这是第3层级
			return Benz()			# 本行代码缩进12个空格,这是第4层级
		elif brand == "宝马" :
			return BMW()
		elif brand == "比亚迪" :
			return BYD()
		else:
			return "未知品牌,无法创建"

2、答案:

(1)Python缩进的核心规则

  1. 层级决定归属:Python通过缩进量(空格或Tab)判断代码层级关系。同一缩进量的代码视为同一代码块(如if/for/函数体)
  2. 首行禁忌:文件的首行代码绝对不可缩进
  3. 缩进标准:每个层级必须使用4个空格(PEP8规范)。在PyCharm/VSCode中按Tab键时,编辑器会自动转换为4个空格。
  4. 语言差异:与其他语言(如Java/C++)不同,Python使用空格缩进代替 {} 表示代码逻辑层级关系。

(2)按 tab 键使用缩进代码

  1. 在某一行代码开头,按一下 tab 键,IDE会自动将制表符设置成4个空格。
  2. 使用缩进:例子1:缩进体现代码层级性

二、问题:如何规范编写Python注释?单行与多行注释的正确写法是什么?

1、例子1:简单使用单行注释和多行注释

#这是我的第一个Python程序
print("aaa")

'''
我是多行注释
三个单引号实现多行注释
作者:
时间:
'''
print('三个单引号实现多行注释')
"""
三个双引号实现多行注释
作者:
时间:
"""
print('三个双引号实现多行注释')

2、例子2:实际开发中的注释规范

# 单行注释:计算订单总价(金额单位:元)
total_price = quantity * unit_price * 0.9  # 九折优惠

"""
多行注释模板:
函数功能:用户登录验证
参数:
- username: 字符串类型,用户名
- password: 字符串类型,密码
返回值:布尔类型,登录成功返回True
"""
def user_login(username, password):
    # 具体实现省略...

3、答案:

(1)注释是什么

  1. 注释是程序中会被Python解释器忽略的一段文本。你可以通过注释记录任意想写的内容,通常是关于代码功能说明。让自己和他人更容易理解代码。

  2. 注释分为2种:单行注释和多行注释。

(2)使用注释

  1. 单行注释:每行注释前加 # 号。当解释器看到 # ,则忽略这一行 # 后面的内容。
  2. 多行注释:也叫“段注释”。使用三个连续单引号 ''' 或三个双引号 """ 。当解释看到 ''' ,则会
    扫描到下一个 ''' ,然后忽略他们之间的内容。
  3. 使用注释:例子1:简单使用单行注释和多行注释

(3)⚠ 新手注意

  1. 不要混合使用空格和制表符。
  2. 多行注释的本质:三个引号实际是创建了一个字符串对象,当这个字符串未被赋值给变量时,Python解释器会直接忽略它,相当于给代码添加了“不会被执行的说明文字”。(关于本句话的含义,后面讲完面向对象再看)

三、动手试一试

  1. 找出代码种缩进错误:
 def calculate(a, b):
 result = a + b
     return result

参考答案:

def calculate(a, b):
    result = a + b  # 此处缺少缩进,添加4空格缩进。
    return result
  1. 为代码添加专业注释:
def get_discount(price):
    if price > 1000:
        return price * 0.8

参考答案:

def get_discount(price):
    """计算商品折扣价
    参数:
        price (float): 商品原价
    返回值:
        float: 折后价格(满1000打8折)
    """
    if price > 1000:
        return price * 0.8

互动区
遇到问题?在评论区:

  1. 描述问题(带代码截图更好)
  2. 分享学习心得
  3. 给文章提建议

支持作者:点赞 | 收藏 | 关注
你的三连是我更新的最大动力!


你可能感兴趣的:(#,第一章_Python入门,python,代码规范,开发语言,改行学it)