我有實現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）消息處理程序的方法？

回答

我的建議是：

相關問題