2.1.1 注释 | 入门必修 | Py基础

Python 全家桶算法金2023-11-29 16:40

如果你还没有安装好 Anaconda,可以暂时用线上工具替代一下,我推荐一个全球顶级 AI 社区开源工具(点击这里, + New Notebook,+ Add cell 就可以玩耍了)

今天我们要探索的是Python的魔法世界中的一个隐藏宝石——注释。

是的,你没听错,注释,那些看似默默无闻的文本,其实是编程的灵魂!

内容大纲

  1. 注释的基本概念

    定义和作用

    注释与代码的关系

  2. 注释的类型

    单行注释的用法和规则

    多行注释的用法和规则

  3. 注释的最佳实践

    何时使用注释

    如何有效地编写注释

  4. 知识导图

  5. 彩蛋


一、注释的基本概念

1. 定义和作用

想象我们化身成一位时间旅行者,穿越回去解读古代的秘密代码。注释就像是那些古老文本旁的译文,帮助我们理解代码的神秘含义。

它们解释代码做了什么以及为什么要这么做,但不参与任何实际的动作。

2. 注释与代码的关系

注释与代码的关系就像是导演与电影。导演不出现在电影镜头前,但他的指导无处不在。

注释在程序运行时是隐形的,但在代码的背后,它指导着我们理解程序的本质。

二、注释的类型

1. 单行注释

单行注释就像是微博或推特上的短句——简洁而有力。使用#开始,直到行尾。

示例:


# 这是一个单行注释,下面代码运行后会打印出 Hello, world!
print("Hello, world!")

2. 多行注释

而多行注释则像是一首散文诗,跨越多行表达所思所想。使用三引号'''或"""包裹起来。

示例:


"""
这是一个多行注释
可以跨越多行
"""

print("Hello, again!")

三、注释的最佳实践

1. 何时使用注释

注释像是调味品,恰到好处时能让菜肴美味,过多或过少都会破坏风味。当代码复杂或不直观时,加入适量的注释。

2. 如何有效地编写注释

好的注释应该像优秀的电影剧本——清晰、准确、引人入胜。避免废话,直接点题,让人一读就懂。

3. 错误示范

过多无用的注释就像是电影中不停闪现的广告,让人分心。比如:


# 打印 hello world
print("Hello, world!")# 这是多余的,因为代码已经很清晰了

4. 最佳实践

注释应该用来解释那些看起来不明显的部分。例如,解释一个复杂的算法决策,或标记一个未来可能需要修改的地方。


# TODO:优化这个循环,目前效率太低
for i in range(100000):
    # ...

记住,优秀的代码像是一首优美的诗,而注释则是那些让人回味无穷的注解。

四、知识导图

现在,让我们伴随着注释开始我们的编程之旅吧!走你~

五、请你欣赏

看看网络盛传的程序员注释,这得有多无聊(有才)啊,哈哈哈


学员提问


福利:凭小报童购买截图,可享受现价7 折优惠加入[ 算法金 学习陪伴群 ]

如: 现价 99 元,凭购买截图可享受 69.3 元加入

回 Python 编程基础 | 学习入口

去 2.2.1 数字 | 入门必修