写不好代码注释？这份注释指南一定要收好！

之前有读者问，自己一直不明白如何写出合理的代码注释。

这也是不少程序员一直头疼的问题，比如接手新代码时，没有注释，完全搞不清逻辑；自己写的注释，跟不上代码修改，成了误导；复杂逻辑不知道咋注释，别人也看不懂。

  

（听君一席话，听了一席话）

网上也有很多关于代码注释的段子，搞笑中透露着真实的注释现状，比如下面这些注释：

（这也算得上是“风险预警”吧  ↑ ）

（阅读代码的人，心里一定很崩溃 ↑ ） 

还有一种是，注释透露着一种自由的随意感 ：

我们都知道，注释是代码的重要组成部分，它能够为代码的读者提供额外的信息，帮助他们更好地理解代码的功能、逻辑和设计意图。

写出合理的注释不仅能够提高代码的可读性和可维护性，还能促进团队成员之间的有效协作。

本文就将一些经验分享给大家，希望提供一些帮助。

一、明确注释的目的

目标设定理论提出：清晰、明确和可衡量的目标比模糊不清的目标更能提高工作效率。目的也同样。

而我们写注释的主要目的是为了增强代码的可理解性。下面列出了一些具体的注释目的，在写之前帮助我们理清思路，明确行动方向。

（一）解释代码的功能和用途

代码注释要让读者能够快速了解一段代码或一个函数的整体作用。比如，编写了一个函数用于从数据库中获取特定用户的信息，注释就可以这么写：“此函数用于从数据库中检索指定用户的详细信息，包括用户名、电子邮件和年龄等字段。”

实践要点：

• 在注释中明确函数的输入和输出格式，例如数据类型、结构等。
• 提及函数可能抛出的异常或特殊情况。

（二）说明复杂算法或逻辑的工作原理

对于复杂的计算或独特的逻辑流程，注释能够帮助读者理解代码背后的思路。比如，对于一个使用递归实现的斐波那契数列计算函数：

def fibonacci(n):
    """
    此函数使用递归算法计算斐波那契数列的第 n 项
    参数:
    n (int): 要计算的项数
    返回:
    int: 斐波那契数列的第 n 项值
    工作原理:
    欧几里得算法的基本思路是：不断用较小数除以较大数，并将余数赋给较小数，直到余数为 0。
    在本函数中，如果 n 小于等于 0，返回 0；如果 n 等于 1，返回 1；
    否则，返回 fibonacci(n - 1) + fibonacci(n - 2)，通过递归计算得出结果
    """
    if n <= 0:
        return 0
    elif n == 1:
        return 1
    else:
        return fibonacci(n - 1) + fibonacci(n - 2)

实践要点：

• 对于复杂的算法，绘制简单的流程图或架构图，并在注释中引用。
• 解释算法中的关键变量和它们的变化规律。

（三）提供关于特定变量、函数或类的重要信息

解释变量的含义、函数的输入输出以及类的设计目的等。比如：“这个变量 max_attempts 表示尝试连接数据库的最大次数。”

假设我们有一个函数用于计算两个数的最大公约数：

def greatest_common_divisor(a, b):
    """
    此函数用于计算两个整数的最大公约数
    参数:
    a (int): 第一个整数
    b (int): 第二个整数
    返回:
    int: 两个数的最大公约数
    算法: 使用欧几里得算法，其基本步骤为：用较大数除以较小数得到余数，然后将较小数作为新的较大数，余数作为新的较小数，重复此过程，直到余数为 0，此时的除数即为最大公约数
    """
    while b!= 0:
        a, b = b, a % b
    return a

在示例中，就注释清晰地说明了函数的功能、参数和使用的算法。

实践要点：

• 对于类，注释中描述其继承关系、主要方法和属性。
• 对于函数，说明函数的性能特点，例如时间复杂度和空间复杂度。

二、保持简洁明了

注释应该简洁而准确地传达关键信息。避免过于冗长和复杂的描述，以免增加读者的理解负担。例如，不要写一大段文字来解释一个简单的函数，而可以简洁地说：“此函数计算两个整数的平均值，并返回结果。”

在这里，提供一些实践技巧：

• 提炼关键信息，去除不必要的修饰词和废话。
• 对于简单的逻辑，用一句话概括注释。
• 定期审查注释，删除冗余和过时的信息。
• 对于较长的注释，将其拆分成多个短句或段落，增强可读性。

三、采用清晰的语言

使用简单、易懂的词汇和句子结构，避免使用行话、缩写或过于技术化的术语，除非你确定读者一定能理解。所以尽量简单表达，就像在与其他开发者进行交流一样。举个例子，当你在解释一个数据结构时，“这是一个基于链表实现的队列”的表达可能会比说“这是一个采用链表数据结构的 FIFO 队列”更容易被人理解。

在这里，需要注意以下事项：

• 保持语言的一致性，避免在同一项目中使用多种表述方式来表达相同的概念。
• 对于可能有歧义的术语，进行必要的解释。
• 建立项目词汇表，统一关键术语的表述。
• 对于新引入的技术术语，在注释开头进行定义和解释。

四、提供上下文

注释不仅要描述代码本身，还要让读者了解它在整个程序中的位置和作用。还是举个例子：“此函数在用户登录流程中被调用，用于验证用户输入的密码是否正确。” 这样的注释很明显能够帮助读者将当前代码与程序的更大框架联系起来，帮助读者更快理解代码。

为了更好理解和掌握，我们来假设一个场景：我们现在有一个处理订单的模块，其中有一个函数用于计算订单的总价：

def calculate_order_total(order_items):
    """
    此函数在订单处理流程中用于计算订单的总价
    参数:
    order_items (list): 包含订单中各项商品信息的列表，其中商品信息以字典形式存储，包括'price'（价格）和'quantity'（数量）两个键
    注意: 此函数会根据商品的'price'和'quantity'进行计算
    """
    total = 0
    for item in order_items:
        total += item['price'] * item['quantity']
    return total

这里的注释就明确了函数在整个订单处理流程中的位置和作用。

实践要点：

• 引用相关的业务流程文档或需求说明，增强注释的上下文信息。
• 在注释中提及与当前代码相关的其他函数或模块。

五、遵循统一的风格

在整个项目中，要保持注释的格式、标点和命名约定的一致性。这包括注释的位置（行末、函数前等）、注释的符号（例如 Python 中常用的 # ）、以及注释的书写方式（是完整的句子还是短语等）。统一的风格可以使注释看起来更加整洁和专业。

例如，在一个 Python 项目中，规定函数注释采用如下格式：

def some_function(arg1, arg2):
    """
    函数功能的简要描述
    参数:
    arg1 (数据类型) - 参数 1 的描述
    arg2 (数据类型) - 参数 2 的描述
    返回:
    返回值的数据类型 - 返回值的描述
    """
    # 函数体代码

提供一些风格规范的思路：

• 确定统一的注释符号和格式。
• 制定关于注释内容的详细规范，如参数描述、返回值描述的格式。
• 使用工具（如代码规范检查插件）来自动检查注释风格的一致性。
• 为新加入项目的开发者提供详细的注释风格指南。

六、注释关键代码

重点注释那些容易引起混淆、不常见或对程序的正确性和性能有重要影响的部分。对于简单和直观的代码，或许不需要过多注释，但对于复杂的条件判断、循环结构或与外部系统的交互部分，详细的注释是很有必要的。还是以例子来直观解释下：

def process_data(data):
    """
    此函数处理传入的数据
    参数:
    data (列表) - 包含待处理数据的列表
    以下的条件判断用于处理不同的数据类型
    如果数据是整数列表，执行求和操作
    如果数据是字符串列表，连接所有字符串
    """
    if all(isinstance(item, int) for item in data):
        total = 0
        for num in data:
            total += num
        return total
    elif all(isinstance(item, str) for item in data):
        result = ''
        for string in data:
            result += string
        return result

实践要点：

• 分析代码的复杂度和易错性。
• 关注与业务逻辑紧密相关的核心代码部分。
• 对于关键代码，添加注释说明其优化的思路和考虑的因素。
• 在关键代码的注释中引用相关的技术文档或最佳实践。

七、及时更新注释

随着代码的修改和更新，相应的注释也必须保持同步。过时或不正确的注释可能会比没有注释更糟糕，因为它们会误导读者。在修改代码时，务必检查并更新相关的注释，确保它们准确反映了代码的最新状态。

更新策略：

• 建立  代码审查机制，确保注释的更新。
• 养成在修改代码的同时更新注释的习惯。
• 使用版本控制系统来跟踪注释的变更历史。
• 在代码提交信息中说明对注释的修改内容。

八、示例

对于一些复杂的概念或逻辑，提供简单的示例可以极大地增强注释的效果。例如，如果你在解释一个正则表达式的用法，可以给出几个匹配和不匹配的示例字符串。

假设我们有一个正则表达式用于验证电子邮件地址：

import re
email_pattern = r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"
def validate_email(email):
    """
    此函数使用正则表达式验证电子邮件地址的有效性
    参数:
    email (str) - 待验证的电子邮件地址
    示例:
    有效电子邮件: "test@example.com", "user123@gmail.com"
    无效电子邮件: "invalid_email", "no_domain@"
    """
    if re.match(email_pattern, email):
        return True
    else:
        return False

实践要点：

• 确保示例具有代表性，涵盖各种可能的情况。
• 对于示例中的关键部分，在注释中进行特别说明。

合理的注释是优质代码的重要标志之一。在日常编程中尝试遵循上述原则和方法，可以为写出清晰、有用的注释提供帮助，同时提高代码的质量和可维护性，为自己和其他开发者节省大量的时间和精力。

最后也希望大家永远不会碰见开头那样的代码注释~