Intellij IDEA(14 Ultimate)可以生成基于正则表达式的TODO评论吗?

时间:2015-03-12 08:05:41

标签: intellij-idea

几年前我在一家公司工作,我可以按CTRL+T并生成TODO评论 - 说我的ID被其他开发人员识别为xy45然后生成的评论是:

//TODO (xy45): 

Intellij 14 Ultimate中是否提供了某些内容,或者他们是否为自己编写了自己的插件?

我尝试了什么: Webreserach,Jetbrais文档 - 它看起来不可能开箱即用(我会在为其编写插件之前询问)或被各种搜索结果掩盖TODO-view(由于我的不良研究技巧)。

3 个答案:

答案 0 :(得分:1)

IntelliJ IDEA中没有内置功能来生成此类注释,因此看起来他们确实编写了自己的插件。

答案 1 :(得分:0)

发现一些非常相似但不能用于快捷方式的东西:

File -> Settings -> Live Templates

add a new Template of the Form: // TODO (xy45):

我想这张照片说的是允许自定义(请参阅Jetbrains文档了解更多可能性)。例如。浏览到设置中的“实时模板”部分,添加新的实时模板(上图中的小绿色十字,右上角)并设置此实时模板适用的上下文。

注意:一旦您将实时模板定义为适用于Java(上图中显示红色感叹号的...Change)上下文,您只需键入“t”,“todo”并点击{{ 1}}(或您为代码完成定义的快捷方式)。

答案 2 :(得分:0)

我建议重新考虑使用这种做法。通常,您不应该包含通过版本控制系统轻松且可靠地访问的冗余信息(可以直接在编辑器中使用Annotate功能在Idea中轻松获得)。它与不使用javadoc标记@author类似,因为随之提供的信息通常是过时的不准确和冗余。另外,我不认为TODO的作者是非常有价值的信息。解决问题的人往往是完全不同的人,TODO应该有很好的文档和描述。当您找到自己的旧TODO时,即使您是作者,您也经常不记得所有必需的信息。

但是,不是添加作者姓名,一个好的做法是在您的问题管理系统中创建一个任务,并将此任务的标识符添加到待办事项的描述中。通过这种方式,您可以在一个地方获得所有待办事项,您可以在任务中添加其他信息,跟踪进度,分配等等。我的经验是,如果您不使用它,todos往往会留在代码中,并且过了一段时间没有人清楚地记得问题的细节。另外,todo中提到的作者通常已经为另一家公司工作了。

带问题ID的带注释的TODO Annotated TODO with issue ID