2012-11-19 76 views
3

我想知道,是否有可能爲公共字符串常量生成javadoc來生成包含其內容的javadoc? 例如 對於現場:javadoc中的字符串內容

public static final String MENU = "menu_2"; 

它會生成Javadoc這樣的:

/** 
    * value: menu_2 
    */ 

回答

4

您可以在註釋直接引用它:

/** 
* MENU static field whose value is: {@value #MENU} 
*/ 
public static final String MENU = "menu_2"; 
+0

很好,謝謝! –

0

不符合標準的Javadoc工具。 編輯我糾正了,謝謝@Aleksandr!

我也建議不要這樣做。您應該使用javadoc將該上下文添加到該字段中。例如,該字段意味着什麼?不只是寫出該領域的價值。任何人都可以查看代碼以找出該價值。大多數IDE也可以爲你檢索。在Eclipse中,按住SHIFT鍵的同時將鼠標懸停在一個引用上會給你聲明。

+0

更不用說它很難維護和容易出錯。 – DPM