此项目不再处于积极开发状态。该项目仍可使用，但不会添加新功能，并且可能会不时出现问题。

待审评

SublimeText插件，用于审查代码中的待审评（以及其他）注释。

查看问题以获取即将推出的功能

这是一个基于 @robcowie's SublimeTodo 的分支。不幸的是，它不支持 ST3，并且他已经无法再维护它了。此外，这包括了 @dnatag's ST3 分支，这使我能够相对快速地修复所有内容。

安装

Package Control（推荐）

待审评可通过 Package Control 访问。如果您没有 Package Control，请按照这些 说明 安装它，它非常有用。一旦安装完成，只需打开您的命令板，输入 安装包，然后在下一个提示下，输入 待审评，您就设置好了！

Git 克隆

如果您在分支此项目或出于其他原因不想使用 Package Control，您可以通过这种方式安装此包。首先，通过转到（首选项 -> 浏览包）找到您的包目录位置，然后像平常一样运行git clone。

使用方法

只需简单打开 Sublime Text 命令面板，找到 TodoReview: 项目文件 命令。这将生成一个 TODO 列表，使用您项目中当前所有文件，除了您在设置中排除的那些。如果您还想将打开的文件包括在搜索中，可以使用 TodoReview: 项目和打开的文件 命令；就这么简单！然后，您可以使用这些结果进行跳转。此外，您可以在侧边栏中右键单击文件或文件夹并选择 TodoReview 来限制搜索。

导航结果

列表生成后，作为一位熟练的程序员，您自然会希望使用键盘导航它，对吧？好吧，您很幸运！

通过按 上箭头 或 下箭头 键，您可以快速导航结果。如果您是 VIM 用户，您也可以使用 j 和 k 分别进行导航。您还可以使用 page up 或 page down 来一次跳过 10 行。一旦导航到您想要的结果，只需按 enter 键即可在一个新标签页中打开结果，同时转到相应的行。您还可以随时按 r 键刷新列表，它使用与上次搜索相同的参数。

优先级

从 2.1.0 版本开始，结果现在已完全索引和排序。您现在可以在 TODO 的任何地方添加 (0) 来分配 0 优先级。这可以与从 1 到 99 的任何数字一起使用。TODO 将按最低数字首先排序；所有没有优先级的匹配项将被分配一个优先级 50。以下是一些示例输出

// Tuesday 09/30/14 at 10:46AM - 27 files in 0.16 secs

## TODO (5)
1. 3.0.0.txt:3   Press `r` to refresh! (1)
2. readme.md:1   Take a screenshot
3. readme.md:2   Document goodies
4. 3.0.0.txt:1   Make sure @tags work
5. 3.0.0.txt:2   Other [formatting] too

## TEST (2)
1. 3.0.0.txt:4   (2) Priorities work?
2. 3.0.0.txt:5   Read from buffer

颜色方案

您可以使用类似 @tomorrow 或 @bug 的方式标记任务。这些只是示例，任何在 @ 符号之后，空格之前的任何内容都将相应突出显示。如果您像我一样，您可能还想有一个额外的选项，以防某些东西真的需要突出显示，例如参考链接等。您还可以使用 [Comment] 或 [Need To Test] 作为另一类型的参考，根据需要。与带有 @ 符号的标签不同，您可以在括号之间使用空格。

这些标签的颜色取决于您的颜色方案。长期以来，Sublime Text 一直是个痛点，插件无法在不进行一些手动编辑的情况下影响颜色方案。我使用并推荐 Tomorrow Night 颜色方案。但是，如果您不是，以下是其对应的颜色

• 报告标题 与 注释 的颜色相同
• 模式标题 与 字符串 的颜色相同
• 行号 与 函数 的颜色相同
• 优先级 与 变量 的颜色相同
• 括号标签 与 类 的颜色相同
• @Tags 与 关键字 的颜色相同

这些可能在未来会发生变化，但就目前而言，这是处理突出显示差异的最好方式。

配置

全局配置可以在标准包设置菜单（首选项 -> 包设置 -> TodoReview）中设置。然而，此插件还提供特定于项目的设置。要基于项目覆盖全局设置，请相应地编辑您的 .sublime-project 文件，以下是对设置的更多详细信息

{
    "folders": [],
    "settings": {
        "todoreview": {
            "exclude_folders": [
                "*.git*"
            ]
        }
    }
}

添加注释模式

您可以使用任何 RegExp 模式进行搜索，这为自定义留下了很多空间。每个模式将在结果页中生成不同的组。对于精简安装，只有 TODO 包含在默认配置中。使用以下示例添加您自己的搜索模式。有关 regex 的更多信息，请访问 Regex 101 并尝试默认模式

请注意，必须提供至少一个命名组，将用于在结果中分组注释

"patterns": {
    "TODO": "TODO[\\s]*?:[\\s]*(?P<todo>.*)$",
    "NOTE": "NOTE[\\s]*?:[\\s]*(?P<note>.*)$",
    "FIXME": "FIX ?ME[\\s]*?:[\\s]*(?P<fixme>.*)$",
    "CHANGED": "CHANGED[\\s]*?:[\\s]*(?P<changed>.*)$"
}

注释模式权重

如果您想要非字母排序的模式，可以使用patterns_weight设置。关于此配置项有一些非常重要的注意事项。首先，密钥必须是大写，否则此配置项将不会工作。密钥还必须与命名的模式组匹配。值可以是数字或字符串，它仅被评估为字母优先覆盖。所有未提及的模式将与新值保持相同的字母顺序权重。例如：

"patterns_weight": {
    "NOTE": 3,
    "TEST": "z"
}

//Order:
//Note
//Fixme
//Todo
//Test

排除文件和文件夹

显然，一些文件或文件夹可能需要从您的研究中排除。例如，您的.git文件夹，其中包含大量文件，搜索将花费很长时间，但您可能不希望得到这些结果。

要排除目录，请将目录名称添加到exclude_folders中。这是一个glob字段，所以请确保在需要的位置添加通配符。已经为您添加了一个.git文件夹的预设。以下是一个示例：

"exclude_folders": [
    "*.git*",
    "*node_modules*"
]

此外，如果您想要排除个别文件，可以通过exclude_files基于名称或glob模式进行排除。以下是一个示例：

"exclude_files": [
    "*.sublime-workspace",
    "*.sublime-project"
]

包含目录

虽然对于大多数人来说这似乎是多余的，但我也包括了一个设置来覆盖默认路径，只允许搜索特定文件夹。这不是glob设置，而是您希望搜索的文件夹的绝对路径，甚至可能超出您的项目范围。请注意，此设置将由传递给命令的paths参数覆盖；例如，侧边栏快捷方式仍将正常工作，独立于此设置。以下是一个示例：

"include_paths": [
    "~/currentproject/folder",
    "~/Users/Jonathan/anotherfolder"
]

解析符号链接

TodoReview试图解析您的项目中的符号链接，以便引用磁盘上的实际文件。这种行为减少了与符号链接损坏相关的大量问题，例如有不存在的目标。这可能不适用于所有工作流程，例如与远程服务器一起工作。因此，您可以根据TodoReview来设置希望如何处理符号链接。这更多是一个高级设置，如果您没有关于符号链接的错误，您很可能不需要更改此设置。默认值是true。

"resolve_symlinks": false

区分大小写

默认情况下，搜索不分大小写。如果您想要强制大小写敏感，可以将以下内容添加到您的配置中。默认值是false。

"case_sensitive": true

编码

如果您打算在注释中使用任何非UTF-8字符，可能需要将此配置项更改为项目的文件编码。请注意，此设置不影响当前打开的文件，因为Sublime Text在缓冲文件上处理编码。所有需要打开的文件都将通过Python打开，此设置直接影响文件打开时的编码。默认值是utf-8。

"encoding": "western-258"

将文件夹包含在结果中

如果您有一个具有重复文件名称的大型项目，显示文件的文件夹有时也有用。这将结果index.js:1变为lib/index.js:1。结果按照字母顺序排序，以将文件夹和文件分组。请注意，结果首先按优先级排序。默认值是false。

此外，如果您选择在报告中包含文件夹，您还可以指定报告路径的文件夹深度。

"render_include_folder": true,
"render_folder_depth": 5

如果您在项目或打开的文件夹中使用Sublime，将"render_folder_depth"设置为"auto"可能会有所帮助，这样将渲染报告中的文件夹，直到任何打开的文件夹。例如，如果您在一个位于/home/user/code/project的项目中工作，并在/home/user/code/project/src/file.cpp中有一个TODO，报告将渲染文件为src/file.cpp。

对齐结果

TodoReview现在自动为您对齐注释，计算最长的结果并根据此对齐其余部分的注释。系统的最大空格默认值为50，这可以防止单个文件异常长的长度完全破坏您的结果。您可以通过编辑render_maxspaces来更改此设置。

"render_maxspaces": 100

报告标题

如果您总是有强烈的冲动要么删除要么编辑标准的报告标题，现在您可以通过编辑render_header_format和render_header_date来实现。这两个都使用标准的正则表达式替换来创建报告标题。将render_header_format设置为空字符串将完全删除标题。示例：

"render_header_format": "%d - %c files in %t secs",
"render_header_date": "%A %m/%d/%y at %I:%M%p"

• %d - 格式化的日期字符串
• %c - 文件总数
• %t - 总计时间
• 日期格式化可以在Python文档中找到。

自定义跳过行数

如果您在翻页时希望每次跳过多于或少于10行，我们为您提供了这项设置！这些默认设置为10。

"navigation_forward_skip": 10,
"navigation_backward_skip": 10

参数

TodoReview搜索引擎接受多个参数以更好地找到您想要的内容。这些参数在许多糖函数中自动生成，如使用侧边栏或命令选择板，但您也可以创建自己的快捷键以利用它们。

• paths - 要搜索的路径数组
• open_files - 布尔值，表示是否包含打开的文件
• open_files_only - 布尔值，表示是否仅限制搜索到打开的文件
• current_file - 布尔值，表示是否仅限制搜索到当前打开的文件
• settings - 设置对象；此设置将覆盖所有项目设置。

许可证

MIT许可证（MIT）

版权所有 © 2014 Jonathan Delgado

兹特此允诺，免费许可任何获得本软件及其相关文档副本（统称“软件”）的个人在未经限制的情况下使用软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向任何提供软件的人使用软件，但受以下条件约束：

上述版权声明和本许可声明应包含在软件的所有副本或大部分副本中。

本软件按“原样”提供，不提供任何形式的保证，无论明示或暗示，包括但不限于适销性、适用于特定目的和不侵权的保证。在任何情况下，作者或版权所有者不对任何索赔、损害或其他责任（无论由于合同、侵权或其他方式而产生）负责，无论是因软件本身、使用或与其相关联而引起。