Intellij IDEA (14 Ultimate) 可以生成基于正则表达式的 TODO 注释吗?
Can Intellij IDEA (14 Ultimate) generate regex based TODO-comments?
几年前,我在一家公司工作,在那里我可以按 CTRL+T
并生成了一个 TODO 注释——假设其他开发人员识别的我的 ID 是 xy45,那么生成的注释是:
//TODO (xy45):
Intellij 14 Ultimate 中是否提供了一些东西,或者他们是否为此编写了自己的插件?
我尝试了什么: Webreserach、Jetbrais 文档 - 它看起来不可能开箱即用(但是我在为它编写插件之前询问过)或被关于 TODO 视图的各种搜索结果(由于我的研究技能不好)。
IntelliJ IDEA 中没有生成此类评论的内置功能,因此看起来他们确实编写了自己的插件。
找到了一些非常相似但不能绑定到快捷方式的东西:
File -> Settings -> Live Templates
我猜图片上说允许自定义(请参阅 Jetbrains 文档了解更多可能性)。例如。浏览到设置中的 Live Template 部分,添加一个新的 Live Template(上图中右上角的小绿色十字)并设置此 Live Template 适用的上下文。
注意:一旦您将实时模板定义为适用于 Java(上图中显示红色感叹号的 ...Change
)上下文,您只需键入 "t" , "todo" 并点击 CTRL+Space
(或您为代码完成定义的快捷方式)。
我建议重新考虑使用这种做法。通常,您不应该包含冗余信息,这些信息可以通过您的版本控制系统轻松且更可靠地访问(使用 Annotate 功能可以直接在 Idea 中直接在编辑器中轻松获得)。它类似于不使用 javadoc 标记 @author
,因为它提供的信息通常是过时的、不准确的和多余的。另外,我不认为 TODO 的作者是那么有价值的信息。解决问题的人通常是完全不同的人,TODO 应该有详细的文档和描述。当您发现自己的旧 TODO 文档很少时,即使您是作者,您也常常不记得所有必需的信息。
但是,不要添加作者姓名,一个好的做法是在您的问题管理系统中创建一个任务,并将该任务的标识符添加到待办事项的描述中。通过这种方式,您可以将所有待办事项集中在一个地方,您可以向任务添加其他信息、跟踪进度、分配任务等。我的经验是,如果您不使用它,待办事项往往会永远留在代码中,并且一段时间后,没有人清楚地记得问题的细节。此外,待办事项中提到的作者通常已经在另一家公司工作。
带问题 ID 的注释 TODO
几年前,我在一家公司工作,在那里我可以按 CTRL+T
并生成了一个 TODO 注释——假设其他开发人员识别的我的 ID 是 xy45,那么生成的注释是:
//TODO (xy45):
Intellij 14 Ultimate 中是否提供了一些东西,或者他们是否为此编写了自己的插件?
我尝试了什么: Webreserach、Jetbrais 文档 - 它看起来不可能开箱即用(但是我在为它编写插件之前询问过)或被关于 TODO 视图的各种搜索结果(由于我的研究技能不好)。
IntelliJ IDEA 中没有生成此类评论的内置功能,因此看起来他们确实编写了自己的插件。
找到了一些非常相似但不能绑定到快捷方式的东西:
File -> Settings -> Live Templates
我猜图片上说允许自定义(请参阅 Jetbrains 文档了解更多可能性)。例如。浏览到设置中的 Live Template 部分,添加一个新的 Live Template(上图中右上角的小绿色十字)并设置此 Live Template 适用的上下文。
注意:一旦您将实时模板定义为适用于 Java(上图中显示红色感叹号的 ...Change
)上下文,您只需键入 "t" , "todo" 并点击 CTRL+Space
(或您为代码完成定义的快捷方式)。
我建议重新考虑使用这种做法。通常,您不应该包含冗余信息,这些信息可以通过您的版本控制系统轻松且更可靠地访问(使用 Annotate 功能可以直接在 Idea 中直接在编辑器中轻松获得)。它类似于不使用 javadoc 标记 @author
,因为它提供的信息通常是过时的、不准确的和多余的。另外,我不认为 TODO 的作者是那么有价值的信息。解决问题的人通常是完全不同的人,TODO 应该有详细的文档和描述。当您发现自己的旧 TODO 文档很少时,即使您是作者,您也常常不记得所有必需的信息。
但是,不要添加作者姓名,一个好的做法是在您的问题管理系统中创建一个任务,并将该任务的标识符添加到待办事项的描述中。通过这种方式,您可以将所有待办事项集中在一个地方,您可以向任务添加其他信息、跟踪进度、分配任务等。我的经验是,如果您不使用它,待办事项往往会永远留在代码中,并且一段时间后,没有人清楚地记得问题的细节。此外,待办事项中提到的作者通常已经在另一家公司工作。
带问题 ID 的注释 TODO