TODO 注释
有时,您需要标记代码的部分以供将来参考:需要优化和改进的区域、可能的更改、需要讨论的问题等。 PyCharm 允许您添加在编辑器中 高亮显示 、建立索引,并在 TODO 工具窗口中列出的特殊类型注释。 这样,您和您的团队成员就可以跟踪需要关注的问题。

默认情况下,PyCharm 能识别两个模式: TODO 和 FIXME ,且不区分大小写。 这些模式可用于任何受支持文件类型的行注释和块注释中。 您可以修改默认模式,或在必要时 添加您自己的模式。
使用您正在使用的语言的标准注释样式编写 TODO。 在 Markdown 中,您可以 模拟注释。
创建多行 TODO 项
缩进紧随初始注释行之后的注释行文本。
您可以使用空格和制表符,或两者混用,为多行 TODO 项缩进。
禁用多行 TODO 项
按 Ctrl+Alt+S 打开设置,然后选择 。
清除 将以下行中的缩进文本视为同一TODO 的一部分 复选框。

查看 TODO 项
打开 TODO 工具窗口: 。
使用选项卡更改您要查看的 TODO 项的来源:来自当前项目中的所有文件、仅来自当前文件、基于特定的 范围的文件,或来自 活动更改列表 中的文件(如果您已配置 版本控制集成)。
要跳转到源代码中的 TODO 注释,请在 TODO 工具窗口中点击相应的 TODO 项。 若要禁用此行为,请使用工具栏上的 一键导航 按钮 (在这种情况下,您需要双击 TODO 项才能跳转到相关注释)。

添加自定义模式并筛选 TODO 项
您可以添加自己的模式,并筛选列表,仅显示与特定模式匹配的 TODO 项。 例如,您可以选择使用 OPTIMIZE 模式标记代码中可能需要优化的位置,并在 TODO 工具窗口中查看时忽略所有其他类型的 TODO 项。
在 设置 对话框(Ctrl+Alt+S )中,选择 。
使用 正则表达式指定自定义模式。
例如,要在注释中为单词
OPTIMIZE添加一个模式,请在 TODO 对话框的 模式 部分点击,然后键入以下正则表达式:
\boptimize\b.*这将匹配单词 "optimize"(
\b表示单词边界),并允许注释中包含任意数量的其他字符。然后点击 确定(O) 以保存新模式。
添加一个过滤器以对 TODO 模式进行分组,并在 TODO 工具窗口中分别查看相应的 TODO 项。
例如,要添加包含新模式的
Optimization过滤器,请在 TODO 对话框的 筛选器 部分点击,将其名称指定为
Optimization,并选择要包含在此过滤器中的新模式。然后点击 确定(O) 以保存新过滤器。
点击 确定(O) 以在 TODO 设置对话框中应用更改。
要应用新过滤器,请在 TODO 工具窗口中点击
,然后选择
Optimization过滤器。
您为某个模式选择的图标会显示在 TODO 工具窗口中,以更好地区分各类 TODO 项。 通过为某个模式启用 区分大小写 复选框,您可以强制该模式仅按指定的大小写进行匹配。