Правильное форматирование Javadoc - PullRequest
Новая
       9

Правильное форматирование Javadoc

0 голосов
/ 20 декабря 2018

Я новичок в программировании / Java и последние пару недель пытался научить себя этому, используя несколько бесплатных учебников и онлайн-ресурсов.Я подумал, что хороший способ научиться - это построить ролевую игру, которая мне нравится, в Java-программу.При этом я знаю, что многие люди не документируют свой код эффективно и хотят, чтобы это не стало привычкой, поэтому я стараюсь документировать все как можно более подробно.Я не могу понять, правильно ли я это документирую, даже когда ссылаюсь на страницу Javadoc, поэтому любая помощь будет принята с благодарностью.По сути, у меня есть класс «Персонаж», который реализует все необходимые аспекты персонажа в этой игре.Например, у меня есть перечисление, представляющее собой список возможных оценок способностей персонажа в игре: 

/**
 * AbilityScores is an enum type containing all the possible ability scores in the game. It is
 * utilized by the HashMap {@link #abilities} for the keys with an int being used as the values.
 */
private enum AbilityScores {
    STRENGTH,
    DEXTERITY,
    CONSTITUTION,
    INTELLIGENCE,
    WISDOM,
    CHARISMA,
    INSPIRATION,
    ARMOURCLASS
}

Затем у меня есть соответствующий HashMap: 

 /**
 * abilities is a {@link HashMap} collection that contains {@link AbilityScores} as
 * keys and {@link Integer} as values.
 */
private HashMap<AbilityScores, Integer> abilities = new HashMap<AbilityScores, Integer>();

И затемВот пример моего метода доступа для силы персонажа: 

/**
 * This method returns a character's strength in the form of an integer.
 * @return strength as an integer.
 */
public int getStrength() {
    return abilities.get(AbilityScores.STRENGTH);
}

Правильно ли я это документирую или неправильно использовал '@link' и т. д. Я нашел несколько примеров, но я не был на 100%конечно, так как я не смог найти пример (извинения, если он есть), где он показал, что все начинаются до конца, как этот.

Любой вклад или руководство приветствуются!Спасибо

...