代码中的注释

5.1 如何写注释

在Python中，就像在许多编程语言中一样，你可以在代码中写注释。注释帮助程序员和项目中的其他人理解代码，这在协作和长期维护程序时特别有用。在Python中，有几种方法可以在代码中添加注释。

单行注释：

以符号#开头。 #之后的所有内容，Python会忽略。这种类型的注释通常用于对特定代码行的简短说明或解释。例子：

# 这是单行注释
print("Hello, World!") # 对函数行为的解释

多行注释：

在Python中，官方没有专门的多行注释语法，但可以通过多个单行注释或使用三引号实现，尽管后者实际上是一个多行字符串字面量，不会作为代码执行。例子：

# 这是一个多行注释的例子
# 每行都以符号#开头
      

或者：

"""
这是多行字符串字面量，可以用作注释。
Python将其解释为字符串，但如果没有赋值给变量或在表达式中使用，则不会对其做任何处理。
"""
    
      

5.2 为什么要写注释

在代码中使用注释可以提高代码的可读性，简化维护和更新，并促进团队中的更高效协作。注释应简洁但信息量大，并保持相关性，以便作为代码的有用文档，而不是填充不必要的信息。

文档字符串(docstrings)：

这些字符串通常位于模块、类、方法和函数的开头，以描述它们的目的。它们用三个双引号括起来，可以用于自动生成文档。

例子：

def add(a, b):
"""
    两个数相加的函数。
    :param a: 第一个加数
    :param b: 第二个加数
    :return: a和b的和
    """
    return a + b

在编程的世界里，有时候开发者会在代码中添加注释，这些注释不仅仅是解释，还能带来一丝微笑。这里有一些在代码中可以见到的搞笑注释的例子：

例子1

 

            # 我本想解释这里发生了什么，但我自己也不清楚。
        

例子2

 

    # 如果这不工作，那一定是别人的错。

例子3

 

    # 来了，看了，改了…然后坏了。

例子4

 

    # 当我写下这些的时候，只有我和上帝知道这怎么回事。 
    # 现在只有上帝知道。

这些注释可以为开发过程添加轻松和幽默的元素，使代码库不再单调。它们也可以提醒我们，软件开发是一个创造性且充满人性的过程。

5.3 快速注释代码

在PyCharm中，你可以使用快捷键快速注释或取消注释代码。为此，请选择你想要更改的代码行，然后按下Windows上的 Ctrl + /（或macOS上的 Cmd + /）。这个按键组合会在每一行前添加或移除注释符号，让这个过程快速且高效。