我有实现Handler.Callback 如何记录（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 doc。

感谢

来源

2011-09-27 grunk

我的建议是：

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

来源

2011-09-27 14:43:47

MSG_X名称代表示例，我的静态字段名列前茅。无论如何，@link似乎是一个很好的解决方案。 – grunk

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

来源

2011-09-27 14:34:48 slayton

是，孙写的说明每个静态费尔德早在2004年;但是，他正在寻求一种特定的方式来标记他的代码，以了解他的情况。 –

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

回答

我的建议是：

相关问题