java - javadoc @global或@memberAttribute

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标签是因为这是我正在使用的环境。

最佳答案

您可以将@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}。

关于java - javadoc @global或@memberAttribute，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/13547349/