是否有可能在 Eclipse 中自动对类、方法、构造函数等进行注释?

是否有可能在 Eclipse 中自动对类、方法、构造函数等进行注释?


假设我在 Eclipse 中创建一个名为“MyClass”的新类,则将生成如下代码:

public class MyClass
{

}


按照个人惯例,我总是用这样的评论来结束最后一个括号:

public class MyClass
{

} // end of class MyClass



  • 那么,是否可以为每个类、方法、构造函数等插入这样的注释?
  • 是否可以用相关名称来“播种”评论?

...例如:  // end of class (class name here) 

答案1

是的,几乎如此,如果你忽略回车符的话。

转到窗口 -> 首选项 -> Java -> 代码样式 - 代码模板

这是在 Eclipse Indigo 上 - 在其他版本中可能会有所不同。

现在在右侧的“配置生成的代码...”面板中,打开“代码”分支并选择并编辑“新 Java 文件”条目。

在“编辑”对话框的“模式”文本框中,您将看到以下内容:

${filecomment}
${package_declaration}

${typecomment}
${type_declaration}

您需要将其修改为:

${filecomment}
${package_declaration}

${typecomment}
${type_declaration}//end of ${type_name}

然后保存并关闭。尝试创建一个新类,你会看到它如下所示:

package com.nomadsoft.cortex.application;

public class AdamsClass {

}
//end of AdamsClass

不幸的是,您无法删除将注释放在下一行的回车符。它在 Eclipse 中是硬编码的。

根据您想要付出的努力,您可以选择如何将注释放在与结束括号相同的行上:

(选项 1)您可以编辑 JDT jar 中的模板文件:

eclipse\plugins\org.eclipse.jdt.ui_*.jar

打开 templates/default-codetemplates.xml 并在 xml 中找到“newtype”模板,然后将“${type_declaration}”替换为

public class ${type_name} \{
\} // end of ${type_name}

(选项 2)编写一个完整的插件来执行此操作。我很乐意有时间这样做。也许你会。参见在此处输入链接描述

答案2

在我看来,这是一种不好的做法,因为评论可能会不同步。

然而,你可以使用Bracketeer 插件(也可以看看这篇博文)。插件会自动显示结束注释,如您所愿:

Bracketeer 示例

而不将它们保存到源文件中。因此,“幻像”注释始终反映代码的当前状态,让您兼得两全其美。

评论风格是可配置

相关内容