1. 如何写注释
在 Python 中，就像很多其他编程语言一样，可以在代码中写注释。
注释只是写给其他程序员看的文本： Python 解释器完全无视它们，也不会执行注释中的代码。注释有助于程序员和项目中的其他参与者理解代码，尤其是在团队协作和长期维护中格外有用。在 Python 中，有几种方法可以在代码中添加注释。
单行注释：
从符号 # 开始。# 后面的内容，在同一行内都会被 Python 解释器忽略。这种注释通常用于对特定代码行做简短说明或备注。例如：
# 这是单行注释
print("你好，世界！") # 对函数操作的说明
多行注释：
Python 没有官方支持的多行注释，但可以通过多个单行注释或三引号字符串实现。不过需要注意，后者事实上是一个多行字符串常量，并不会作为代码执行。例如：
# 这是多行注释的例子
# 每行都以 # 符号开始
或者：
""" 这是一个多行字符串，可以用作注释。 Python 将其视为一个字符串，但如果不赋值或使用它， Python 不会对它做任何处理。 """
实用！ 字面量是直接在代码中写的小块数据：例如数字、字符串等等。
2. 为什么要写注释
在代码中使用注释可以提高代码的可读性，方便维护和更新，同时也能促进团队的高效协作。注释应当简洁明了，提供有用的信息，并且保持与代码相关，以免添加过多冗余信息。
文档字符串 (docstrings):
这是通常放在模块、类、方法和函数开头的多行字符串，描述它们的功能。文档字符串用三对双引号括起来，常用于自动生成文档。
例子：
def add(a, b): """ 两个数字相加的函数。 :param a: 第一个加数 :param b: 第二个加数 :return: a 和 b 的和 """ return a + b
在编程世界，开发者有时候会在代码中写一些不仅仅是解释性的，还会让人会心一笑的注释。以下是代码中一些有趣的注释示例：
示例 1：
# 我本来想解释这里发生了什么，但现在连我自己也不明白了。
示例 2：
# 如果这段代码不能工作，那肯定是别人的锅。
示例 3：
# 来了，看到，修了......然后搞坏了。
示例 4：
# 当我写这段代码时，只有我和上帝知道它是怎么工作的。
# 现在只有上帝知道。
示例 5：
# 这里浪费的小时数 = 42。
这些注释可以为开发过程增添趣味，让代码库不至于太过单调。它们也提醒我们，软件开发是一个创造性且充满人性的过程。
5.3 快速注释代码
在 PyCharm IDE 中，你可以通过快捷键快速注释或取消注释代码。只需选中需要注释或取消注释的代码行，然后按下 Windows 的 Ctrl + /（或 macOS 的 Cmd + /）。这个快捷键会在选中的每一行代码开头添加或移除注释符号，让这个操作又快又方便。
GO TO FULL VERSION