Question

我是编程/ 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％整个过程像这样开始。

任何输入或指导表示赞赏！谢谢

Javadoc正确格式

0 个答案: