如何创建包含一些标记的类和类成员的Javadoc HTML页面?

时间:2019-05-23 16:02:50

标签: java javadoc

我必须为我的项目创建javadoc,在该项目中,我只考虑标记为“ @accept ”的类和标记为“ @ignore ”不应视为显示在生成的javadoc html页面中。

上面提到的必须使用 JDK8 完成。

请考虑以下给出的A,B和C类。

A.java

/**
 * @accept
 */
public class A {


    String field1;

    /**
     * @ignore
     */
    String field2;

    public A(String field1) {
        this.field1 = field1;
    }

    /**
     * @ignore
     */
    public A(String field1, String field2) {
        this.field1 = field1;
        this.field2 = field2;
    }

    public void setField1(String field1) {
        this.field1 = field1;
    }

    /**
     * @ignore
     */
    public void setField2(String field2) {
        this.field2 = field2;
    }

}

B.java

public class B {

    // Fields and methods here...

}

C.java

/**
 * @accept
 */
public class C {

    String field1;

    String field2;

    public C(String field1, String field2) {
        this.field1 = field1;
        this.field2 = field2;
    }

}

当我为上述类创建javadoc html时,输出应包含以下内容。

Class A  
- String field1; // field  
- public A(String field1); // constructor  
- public void setField1(String field1); // method  

Class C  
- String field1; // field  
- String field2; // field  
- public C(String field1, String field2); // constructor  

在上述预期输出中,我们看不到B类,因为它没有标签 @accept

对于类A,我们不输入字段 field2 ,构造函数 A(String field1,String field2)和方法 public void setField2 (字符串field2),因为它们带有标签 @ignore

0 个答案:

没有答案