Javadoc正确的格式

我是编程/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>();

我是否正确地记录了这一点，或者我是否错误地使用了“@link”等。我确实找到了一些示例，但我不是100%确定，因为我找不到一个示例（如果有），其中显示了从开始到结束的整个过程，如此

欢迎您的任何意见或指导！

---

谢谢你

IDE应该能帮你做到这一点。或者您可以运行javadoc命令。由于格式化后，javadoc将形成完整的句子，请以大写字母开始所有文档。这里有一些争论的空间，但从长远来看，我认为使用常规句子语法是最好的。这里有一些关于如何使用@link的信息。通常，当我想引用类名时，我只使用{@code。@markspace谢谢。该链接非常详细，我一定会引用它和相应的文档。另外，关于“让您的IDE在这里帮助您”的强+1。如果您没有使用IDE：一定要开始使用IDE，或者使用带有插件的专用代码编辑器来为您执行此操作。您不必猜测是否正确，您的工具应该允许您“显然”执行正确的操作。

/**
 * 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);
}