PyCharm注释详解：TODO、文档注释、注释

PyCharm中，可以使用`# TODO:为特定代码标记待办事项，文档注释通过在代码前添加"""文档注释内容"""或'''文档注释内容'''生成，块注释则是使用快捷键Ctrl+Shift+/（macOS为Cmd+Shift+/`）对选中的多行代码进行注释和取消注释。

TODO注释

作用:用于在代码中标记需要后续完成的任务或改进的地方。
方法:在代码中输入`# TODO:`，后面跟上具体内容，例如：

Python

复制代码

    # TODO: 添加错误处理逻辑
    result = some_operation()

查找:在PyCharm的左下角找到"TODO"工具窗口，可以查看所有标记的TODO项，并直接跳转到对应的代码位置。

文档注释

作用:

用于解释函数、类或方法的用途、参数和返回值，方便他人理解和后续使用。
方法:
1. 将光标放在要注释的代码（如函数或类）的声明前。
2. 输入`"""或'''`，PyCharm会自动生成文档注释的框架。
3. 在框架中填写函数的描述、参数（@param）和返回值（@returns）等信息。

Python

复制代码

    def my_function(arg1, arg2):
        """
        这是一个示例函数。

        Args:
            arg1 (int): 第一个参数。
            arg2 (str): 第二个参数。

        Returns:
            bool: 函数执行的结果。
        """
        pass

配置 :可以在设置/首选项 -> 编辑器 -> 常规 -> 智能按键中，设置是否自动插入文档注释存根。

块注释

作用:

批量注释多行代码，常用于临时禁用一段代码或添加大段的说明。
方法:
- 选中代码:选中需要注释的多行代码。
- 使用快捷键 :
  - Windows/Linux :按下Ctrl + Shift + /。
  - macOS :按下Cmd + Shift + /。
- 取消注释:再次按下相同的快捷键即可取消注释