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 に答える