注释

# 这是单行注释 
# 继续写下去就是多行注释
print(1)  # 行内注释，不影响前面的代码执行
print('#')  # 当【#】前后和其他字符串连接在一起时不当做注释，而是会被当做正常的字符
'''
大段字符串前后使用三个英文半角引号包围
这块字符串不是真正的注释，它会被当成 表达式语句 先构造一个临时 str 对象，再被垃圾回收
写三引号，一般当作 docstring（模块文档）

'''

写注释！

写好注释！

写清楚注释！

无注释版（一脸懵）

from machine import Pin, time_pulse_us
import time
t = Pin(15, Pin.OUT)
e = Pin(14, Pin.IN)
while True:
    t.value(0)
    time.sleep_us(2)
    t.value(1)
    time.sleep_us(10)
    t.value(0)
    d = time_pulse_us(e, 1, 30000)
    print(d * 0.034 / 2)
    time.sleep(0.2)

有注释版（秒懂）

"""
超声波测距示例  (HC-SR04 + RaspBerryPico)
接线：Trig -> GPIO15 , Echo -> GPIO14 , Vcc -> 5V , Gnd -> Gnd
距离结果通过串口打印，单位厘米 cm
"""

from machine import Pin, time_pulse_us
import time

# 引脚初始化
TRIG = Pin(15, Pin.OUT)  # 触发脚：只负责发 10 µs 高电平
ECHO = Pin(14, Pin.IN)   # 回声脚：接收高电平宽度

while True:
    # 1. 产生触发脉冲
    TRIG.value(0)
    time.sleep_us(2)     # 先拉低 2 µs 稳定
    TRIG.value(1)
    time.sleep_us(10)    # 再拉高 10 µs（手册要求 >10 µs）
    TRIG.value(0)        # 拉低结束触发

    # 2. 测量回声高电平持续时间（单位 µs）
    duration = time_pulse_us(ECHO, 1, 30000)  # 超时 30 ms（约 5 m）

    # 3. 换算成距离
    # 声速 340 m/s = 0.034 cm/µs ，来回两次所以要 ÷2
    distance = duration * 0.034 / 2

    # 4. 输出结果
    print("距离 = {:.1f} cm".format(distance))

    # 5. 采样间隔（手册建议 > 60 ms，这里取 200 ms 更稳）
    time.sleep(0.2)

注释的作用：

帮你“开外挂”
考试时你能带一张小抄，写注释就像给未来的自己发一张“允许带的小抄”。
下次比赛、考试、课堂演示，别人还在抓耳挠腮，你 5 分钟改完。
让老师/队友秒懂
老师检查作业，看到清晰注释，会毫不犹豫给你 A+；
参加比赛，裁判一看注释，就知道你不是“复制粘贴”。
防止“灵异事件”
程序偶尔“死机”？十有八九是你忘记某个引脚要“上拉”。
如果写了
# KEY 引脚必须内部上拉，否则悬空会误触发
下次换板子也不会踩坑。

写注释的小口诀
“见数字，写单位；见引脚，写功能；
见算法，写思路；见坑点，写警告。”