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

我有一个实现

因此，在我的代码中，我有如下内容：

@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文档即可

感谢

关于如何对代码进行注释，以便以后生成Java文档。

我的建议： 在class

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
 */

---

MSG_X名称代表示例，我的静态字段的名称当然很好。无论如何，@link似乎是一个很好的解决方案；但是，他要求一种特定的方式来标记他的代码，以适应他的情况。