0

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 标签是因为那是我工作的环境。

4

1 回答 1

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}。

于 2012-11-25T01:59:25.467 回答