PhpStorm 2021.3 Help

待办事项评论

有时,您需要标记部分代码以供将来参考:优化和改进的领域、可能的更改、要讨论的问题等等。PhpStorm 允许您添加特殊类型的评论,这些评论在编辑器中突出显示、索引并在TODO工具窗口中列出。这样,您和您的队友就可以跟踪需要注意的问题。

TODO 注释示例

默认情况下,PhpStorm 可以识别两种模式:小写TODOFIXME大写。这些模式可以在任何支持的文件类型的行和块注释中使用。如有必要,您可以修改默认模式或添加自己的模式。

创建多行 TODO 项

  • 在初始注释行之后的注释行中缩进文本。

    您可以使用空格和制表符,或两者结合来缩进多行 TODO 项。

禁用多行 TODO 项

  1. Ctrl+Alt+S打开 IDE 设置并选择Editor | 待办事项

  2. 清除将以下行中的缩进文本视为同一 TODO复选框的一部分。

多行 TODO 注释示例

查看 TODO 项目

  • 打开TODO工具窗口:查看 | 工具窗口 | 待办事项

使用选项卡更改要查看的 TODO 项的来源:从当前项目中的所有文件,仅当前文件中的文件,基于文件的特定范围,或从活动更改列表中的文件(如果您有版本控制集成配置)。

要跳转到源代码中的 TODO 注释,请在TODO工具窗口中单击相应的 TODO 项。要禁用此行为,请使用工具栏上的单击导航按钮单击导航按钮(在这种情况下,您需要双击 TODO 项以跳转到相关注释)。

TODO 工具窗口

添加自定义模式并过滤 TODO 项

您可以添加自己的模式并过滤列表以仅显示与特定模式匹配的 TODO 项。例如,您可以选择使用模式标记代码中可能优化的位置,并在TODO工具窗口OPTIMIZE中查看所有其他类型的 TODO 项时忽略它们。

  1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,选择Editor | 待办事项

  2. 使用正则表达式来指定自定义模式。

    例如,要为OPTIMIZE项目添加模式,请单击TODO添加按钮对话框的模式部分,然后键入以下正则表达式:

    \b优化\b.*

    然后单击确定以保存新模式。

  3. 添加过滤器对 TODO 模式进行分组,并在TODO工具窗口中分别查看相应的 TODO 项。

    例如,要Optimization使用新模式添加过滤器,请单击TODO对话框添加按钮过滤器部分,指定其名称并选择要包含在此过滤器中的新模式。Optimization

    然后单击确定以保存新过滤器。

  4. 单击确定以应用TODO设置对话框中的更改。

  5. 要应用新过滤器,请在TODO工具窗口中单击过滤 TODO 项目按钮并选择优化过滤器。

您为模式选择的图标显示在TODO工具窗口中,以更好地区分各种 TODO 项。通过启用模式的区分大小写复选框,您可以强制模式仅与指定的大小写匹配。

最后修改:2022 年 2 月 21 日