用于注释掉代码的Java注释

时间:2013-07-04 12:35:39

标签: java annotations refactoring

因此可能很多人在那里我通常会暂时注释掉代码,主要用于调试目的。我现在把类似** DEBUG **或者其他任何容易搜索的东西,但我认为编译器输出警告(甚至是错误),只要它发现暂时注释掉的代码可能有用。我想过使用注释,但注释不能用来标记注释。

有人知道一种更好的方法,而不是在注释掉的代码部分放一个易于搜索的字符串吗?

3 个答案:

答案 0 :(得分:4)

有很多代码检查工具可以提醒您存在您定义的代码模式。他们中的大多数都内置支持检测常见的东西,如代码中留下的“// todo”注释等。

大多数IDE也支持// todo的自动检测(例如,intellij idea)。

常见的命令行工具是checkstyle。你可以将它作为构建的一部分运行,并让它指出这些事情

答案 1 :(得分:3)

至少Eclipse允许您使用(并定义自己的)标记放在注释中,之后可以轻松列出。至少有TODO和XXX,但我相信你也可以自己制作。

答案 2 :(得分:1)

如果您正在使用Maven,请考虑使用taglist-maven-plugin