如何记录（javadoc）消息处理程序方法？

Question

我有一个实现Handler.Callback

的类

所以，在我的代码中，我有类似的东西：

@Override
public boolean handleMessage(Message msg) {
    super.handleMessage(msg);
    switch (msg.what)
    {
        case ThreadMessages.MSG_1:
        {
            break;
        }

        case ThreadMessages.MSG_2:
        {
            break;
        }

        case ThreadMessages.MSG_3:
        {
            break;
        }

        case ThreadMessages.MSG_4:
        {
            break;
        }

        case ThreadMessages.MSG_5:
        {
            break;
        }

    }
    return false;
}

我应该如何评论此方法以反映我的班级可以处理的消息？

这里的目的是让开发人员知道他可以发送给该类的消息，而无需阅读源代码，只需使用java doc。

由于

Answer 1

我的建议：

在课程ThreadMessages中将MSG_1和其他静态字段重命名为一些有意义的名称。

高于handleMessage

添加以下评论：

/**
 * Can handle {@link ThreadMessages#MSG_1}, {@link ThreadMessages#MSG_2}, {@link ThreadMessages#MSG_3}, {@link ThreadMessages#MSG_4}, and {@link ThreadMessages#MSG_5}
 */

在班级ThreadMessages

通过在其上方添加

来解释每个静态场

/**
 * this is used for
 */

Answer 2

Oracle has a great document关于如何评论您的代码，以便您以后可以生成Java文档。