Как показать комментарии конструктора в javadocs? - PullRequest
0 голосов
/ 10 апреля 2019

У меня есть класс с конструктором с геттерами и сеттерами, и мне нужно создать Javadoc для них всех.

У геттеров и сеттеров есть свои комментарии, когда я создавал Javadoc, но по какой-то причине конструктор не появляется в Javadoc. Примечание: я создаю Javadocs в CMD. Я пытался изменить 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.

Ответы [ 2 ]

6 голосов
/ 10 апреля 2019

Вызывает Javadoc с флагом -package , поэтому он включает закрытые для пакета члены API.

-package
Показывает только упакованные, защищенные и общедоступные классы и члены.

6 голосов
/ 10 апреля 2019

Сделайте его общедоступным

public PersonalDetails(String name, String sy, String idNo){

или настройте Javadoc, который также документирует ваш видимый конструктор пакета.

...