Question

我有一个带有getter和setter构造函数的类，需要为它们全部创建一个javadoc。

当我创建javadoc时，getter和setter都有其注释，但是由于某种原因，构造函数未出现在javadoc中。注意：我正在CMD中创建javadocs。我曾经尝试过更改HTML版本，但仍然一无所获

这是该类的外观：

/**
 * PersonalDetails class
 *
 * <p>Details the general information of a person involved in Saint Louis 
 University
 */

public class PersonalDetails {
    private String name;

/**
 * Creates a person with the specified characteristics
 * @param name a String containing the name of the person
 * @param sy   a String specifying the current school year
 * @param idNo a String containing the id number of the person
 */
PersonalDetails(String name, String sy, String idNo){
    this.name = name;
    this.sy = sy;
    this.idNo = idNo;
}

/**
 * Registers the name of the person
 * @param name a String containing the name of the person
 */
public void setName(String name) {
    this.name = name;
}

/**
 * Retrieves the name of the person
 * @return a String representing the name of the person
 */
public String getName() {
    return name;
 }

}

我需要对构造函数PersonalDetails进行注释，以使其出现在javadoc中。

Answer 1

将其设为公开

        fetch('https://facebook.github.io/react-native/movies.json')
            .then(function(response) {
                return response.json();
            })
            .then(function(myJson) {
                alert(JSON.stringify(myJson));
            })
            .catch(function (error) {
                alert(error);
            });

或配置Javadoc，该文档也记录了您的程序包可见的构造函数。

Answer 2

使用-package flag调用javadoc，使其包含程序包专用API成员。

-package
仅显示包，受保护的和公共的类和成员。

如何在javadocs中显示构造函数注释？

2 个答案: