Комментарий документа Java не отображается полностью - PullRequest
1 голос
/ 21 марта 2019

Так что это фрагмент из одного из моих классов с комментарием java doc, когда я называю это java doc, не показывает полностью, только первый параметр показывает, что остальное отсутствует, почему? Что я делаю неправильно? Мне нужно правильно отформатировать?

/**
     * @param String timestamp
     * @param int empire
     * @param int federation
     * @param int independent
     * @param int alliance
     */
    public ReputationEvent(String timestamp, int empire, int federation, int independent, int alliance) {
        super(timestamp);
        this.empire = empire;
        this.federation = federation;
        this.independent = independent;
        this.alliance = alliance;
    }

Вызов класса для создания его нового экземпляра, без отображения полного комментария к документу Java

Ответы [ 2 ]

2 голосов
/ 21 марта 2019

Переключите порядок вашего @param. Обычно вы не пишете тип переменной.

/**
 * <A short description of your method / class / whatever>
 *
 * @param <name of the variable> <describe your variable>
 */

Пример:

/**
 * Print a number on the screen.
 *
 * @param number The number that will be print on the screen.
 */

Источник

0 голосов
/ 21 марта 2019

Синтаксис

@param <name of parameter> <description>

Если вы сгенерируете Javadoc из вашего примера, он выдаст следующую ошибку:

ошибка: @param name не найдено * @param int federation

Поскольку "int" не является ожидаемым именем для параметра, то есть "federation".

...