web-dev-qa-db-ja.com

/ *（非javadoc）の意味

可能性のある複製：
「/ *（non-javadoc）」の意味は十分に理解されていますか？

次の文はどういう意味ですか？

    /* (non-Javadoc)
     * 
     * Standard class loader method to load a class and resolve it.
     * 
     * @see Java.lang.ClassLoader#loadClass(Java.lang.String)
     */
    @SuppressWarnings("unchecked")
javasyntaxcommentsjavadoc
49
Mian Asbat Ahmad

プログラマーがEclipseにJavadocコメントを追加するようにEclipseに要求すると、[編集：Eclipseが考える] Javadocツールが実際にはseしない場所にあるこのメッセージを見ました。

一般的な例は、クラスによって実装されるインターフェースでのメソッドの実装です（Java 6では@Overrideアノテーションが必要です）。Javadocは、-のメソッドに配置されたjavadocを使用します[〜＃〜] interface [〜＃〜]、実装で提供されているものではありません。

コメントの残りの部分は、これを知らない人によって書かれた可能性が高いです。

26
Thorbjørn Ravn Andersen

Javadocは、/ * *で始まるコメントを探します。伝統的に、Java docsの一部となることを意図していないメソッドのコメントは、少なくとも開発環境がEclipseの場合、 "/ *（non-Javadoc）"で始まります。

余談ですが、複数行のコメントinsideメソッドを使用しないでください。たとえば、これを避けてください：

public void iterateEdges()
{
  int i = 0;

  /* 
   * Repeat once for every side of the polygon.
   */
  while (i < 4)
  {
  } 
}

以下が推奨されます。

public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
    ++i;
  } 
}

その理由は、メソッド全体をコメントアウトする可能性を開くためです。

/*
public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
     ++i;
  } 
}
*/

public void iterateEdges()
{
  // For each square Edge.
  for (int index = 0; index < 4; ++index)
  {
  }
}

これで、新しいメソッドの実装中に古いメソッドの動作を見ることができます。これは、デバッグ時にも役立ちます（コードを簡素化するため）。

26
DwB
/*
 * This is the typical structure of a multi-line Java comment.
 */

/**
 * This is the typical structure of a multi-line JavaDoc comment.
 * Note how this one starts with /** 
 */
11
Zoot

単なる普通のコメントです。注は、javadocのベースであるマニュアルを作成する場合、このテキストは追加されないことを意味します。

3
reporter