Eclipse评论自动生成

时间:2016-01-27 23:51:49

标签: java eclipse comments

对于编程课程,我需要在每个类和方法中添加注释,描述以下五个方面:方法字段字段上的方法参数参数方法。前三个将直接放在类标题下,后两个特定于每个方法。

以下是这些评论的示例。

class ConsLoString implements ILoString {
    /*
     * Methods:
     * - String convertToString();
     * - String formatString();
     * Fields:
     * - String first;
     * - ILoString rest
     * Methods on fields:
     * - All String methods
     * - All ILoString methods
     */

    String first;
    ILoString rest;

    ...

自然地,为大文件中的每个类和方法键入所有这些是很繁琐和冗余的。有没有办法在Eclipse或其他方面自动生成这些?

我查看了Eclipse的Java Editor Template Variables,但似乎没有办法在Eclipse的模板编辑器中迭代类中的每个方法/字段。

非常感谢任何帮助!

2 个答案:

答案 0 :(得分:1)

在Eclipse中,转到Window - > Preferences - > Java - >代码风格 - >代码模板 在右侧,单击“代码样式”以展开,单击“方法” - 在底部,选中“自动为新方法和类型添加注释”复选框。您也可以为Fields做同样的事情。

我没有看到你试图记录java类的方式。但如果它是您想要的:请参阅this,然后搜索java ClassSpy ClassMember FIELD METHOD。您可以直接从该链接获取ClassSpy.java类,编译它并执行ClassSpy.class,如:java ClassSpy ConsLoString FIELD METHOD - 它将打印字段,方法作为输出。复制输出并以任何方式使用它。

答案 1 :(得分:1)

在类或方法定义之前键入/**然后单击return时,Eclipse会为类和方法生成一些(模板化的)注释。您可以转到Window> Preferences> Java> Code Style> Code Templates> Comments来定义生成的注释的内容。