• 定义TODO模式和过滤器
    • 基础
    • 定义TODO模式
    • 定义过滤器
  • 另请参阅:

    定义TODO模式和过滤器

    在这个页面中:

    • 基础
    • 定义TODO模式
    • 定义过滤器

    基础

    TODO项在代码中被特定的模式定义。

    当模式改变了,或者添加一个新的模式,PhpStorm扫描整个项目并重建TODO项目的索引。结果显示在TODO工具窗,如查看TODO项章节中所描述。

    默认的,PhpStorm提供两种模式:

    • \btodo\b.*
    • \bfixme\b.*

    常用的模式看起来像todo.*

    你也许想查看特定类型的TODO注释,并且隐藏其它的。出于这个目的,PhpStorm建议使用过滤器。这样你可以展示仅匹配特定模式的项目。

    定义TODO模式

    要定义一个TODO模式,一般遵循以下步骤:

    1. 打开设置对话框的TODO页面
    2. Patterns部分,点击添加按钮新增来创建新的模式或点击编辑按钮修改来更新存在的一个模式。然后添加修改模式对话框打开了。
    3. Pattern字段,输入用来描述模式的正则表达式
    4. Icon列表,选择你想用来标记在TODO工具窗中匹配的TODO项的图标。
    5. 指定颜色和字体属性,PhpStorm将用来在源代码中高亮匹配的注释。
    6. 选择Case sensitive复选框,如果你想让模式大小写敏感。

    定义过滤器

    **要定义过滤器用来显示指定类型的TODO项目,一般按照以下步骤:

    1. 打开设置对话框的TODO页面
    2. Filters部分,点击添加按钮新增来创建新的过滤器或点击编辑按钮修改来更新存在的一个过滤器
    3. 在添加修改过滤器对话框,指定过滤器的名称,然后选择要包含的模式。

    另请参阅:

    规程:

    • TODO工具窗
    • TODO
    • 正则表达式语法参考

    教程和例子:

    • TODO例子
    • 在TODO注释中使用动态模板