將Android枚舉描述顯示在JavaDoc中

Question

我已經在xml中定義了一個自定義屬性，它必須將enum值作爲參數。從我的應用程序的R.attr自動生成的JavaDoc會建立一個名稱和值爲enum的表格，但填寫說明欄無法幫助我。如何定義將出現在JavaDoc中的描述？

一個例子與enum常量屬性：

<declare-styleable name="MyCustomView"> 
    <attr name="directions"> 
     <enum name="up" value="0" /> 
     <enum name="down" value="1" /> 
     <enum name="left" value="2" /> 
     <enum name="right" value="3" /> 
    </attr> 
</declare-styleable> 

爲了說明我的意思，在android.R.attrdirectionPriority的JavaDoc對所有與「不變」，「價值」和「說明」的可能枚舉表所有填寫。

我已經做了大量的研究，並嘗試了試驗和錯誤猜測的標籤，可能允許我包括一個描述，但無濟於事。有誰知道正確的方式來記錄這一點？

Answer 1

解決方法是在每個枚舉前添加註釋。這些註釋會自動轉換爲枚舉描述列。

<declare-styleable name="MyCustomView"> 
    <attr name="directions"> 
     <!-- Go up! --> 
     <enum name="up" value="0" /> 
     <!-- Go down! --> 
     <enum name="down" value="1" /> 
     <!-- Go left! --> 
     <enum name="left" value="2" /> 
     <!-- Go right! --> 
     <enum name="right" value="3" /> 
    </attr> 
</declare-styleable>