javadocs的正确写法

Question

我接到了一项激动人心的工作，要在某些代码中添加一些 javadoc。所以这是我的问题：

为此构造函数编写 javadoc 的正确方法是什么。

public Match(int MatchID, int MatchRound, int HomeTeamID, int GuestTeamID, boolean IsPlayed) {
    this.isPlayed = IsPlayed;
    this.matchID = MatchID;
    this.matchRound = MatchRound;
    this.homeTeamID = HomeTeamID;
    this.guestTeamID = GuestTeamID;
}

Answer 1

这里是格式化的 Javadoc:

/**
 * Constructor for creating a new match.
 * @param MatchID the id of the match
 * @param MatchRound the round for the match
 * @param HomeTeamID the id of the home team
 * @param GuestTeamID the id of the guest team
 * @param IsPlayed whether or not the match is played
 */
public Match(int MatchID, int MatchRound, int HomeTeamID, int GuestTeamID, boolean IsPlayed) {

在 Eclipse 中，您只需在构造函数上方键入 /**，它就会自动生成 Javadoc 模板。

Answer 2

我不会写任何，因为它很明显。

不过，我会重命名所有参数以遵循Java约定。

javadocs的正确写法

The correct way to write javadocs

java

constructor

javadoc