javadoc @global或@memberAttribute

Question

Javadoc是友好的易於自我文檔工具。它有許多直接標記，例如：@param@return@throws。但是，我沒有看到文檔訪問「全局」或「成員屬性」變量的方法。

我已經瀏覽了SO，$ search，Javadoc上的一些java/oracle文檔（example1，example2）。

雖然通常建議通過函數參數傳遞操作變量，但有一些有效的設計場合，函數必須訪問或修改超出其局部範圍的變量（例如：「全局」或「成員屬性」變量）。我試圖找到記錄這種訪問的最佳方式。

基本代碼示例：

<!-- language: lang-java --> 
/** 
* Update various UI widgets text and state. 
* @global mState is read to identify current state. 
*/ 
private void updateWidgetsLook() { 
    // stuff... 
} 

THX - Android電子標籤是因爲這是我的工作環境的

Answer 1

可以使用@link標籤這樣的目的，例如：

。

<!-- language: lang-java --> 
/** 
* Update various UI widgets text and state. 
* {@link #mState} is read to identify current state. 
*/ 
private void updateWidgetsLook() { 
    // stuff... 
} 

在上面的例子中，mstate必須駐留在當前類中。如果它駐留在不同的類中，則可以像訪問它：{@link ResidingClass＃mState}。