Javadoc 正确格式化

12 浏览
0 Comments

Javadoc 正确格式化

我是新手程序员/Java，最近几周一直在尝试使用一些免费的教材和在线资源自学。我认为学习的好方法是将我喜欢的角色扮演游戏转化为Java程序。话虽如此，我知道很多人在编写代码时没有有效地进行文档记录，而我想避免养成这个习惯，所以我试图尽可能详细地记录所有内容。然而，我无法确定我是否正确地进行了文档记录，即使参考了Javadoc页面，所以希望得到任何帮助。基本上，我有一个名为\'Character\'的类，它实现了游戏中角色的所有必要方面。例如，我有一个枚举类型，它是游戏中角色可能的能力值的列表：\n

/**
 * AbilityScores是一个枚举类型，包含游戏中所有可能的能力值。它被HashMap {@link #abilities}用作键，int被用作值。
 */
private enum AbilityScores {
    STRENGTH,
    DEXTERITY,
    CONSTITUTION,
    INTELLIGENCE,
    WISDOM,
    CHARISMA,
    INSPIRATION,
    ARMOURCLASS
}

\n然后我有相应的HashMap：\n

 /**
 * abilities是一个{@link HashMap}集合，包含{@link AbilityScores}作为键，{@link Integer}作为值。
 */
private HashMap abilities = new HashMap();

\n然后这是关于角色力量的访问器方法的一个例子：\n

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

\n我是否正确地进行了文档记录，或者我是否错误地使用了\'@link\'等。我找到了一些例子，但我不能百分之百确定，因为我找不到一个完整的例子（如果有的话，请原谅我），它展示了一个从头到尾的例子。\n非常感谢您的任何意见或指导！\n谢谢

0