Java でのコメント

Java のコメントは、他のほとんどのプログラミング言語と同様、プログラムの実行中に無視される文字です。したがって、サイズが増大することを心配することなく、必要なだけコメントをプログラムに追加できます。コメントは、コード、メソッド、またはクラスの特定のブロックの複雑さを説明するために使用されます。将来このコードを扱うプログラマーにメッセージを残したい場合にも、これらを使用できます。または自分自身のメモ用に。

コメントを強調表示する方法

Java には、テキスト内のコメントを強調表示する 2 つの方法があります。

実装コメント（コードコメント）

1. 行をコメントする

   これは最も一般的に使用されるコメント タイプです。このようなコメントを記述するには、2 つのスラッシュを使用する必要があります//。この場合、コメントは文字の直後から始まり//、行末まで続きます。

   System.out.println("Hello, Java world!");
   // наш комментарий

2. テキストブロックにコメントを付ける

   長いコメントが必要な場合は、各行を記号で始めることができます。/*ただし、コメント ブロックを区切り文字とに制限する方が便利です*/。

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   Java 言語では、シンボルで区切られたコメントをネスト/*できないことを忘れてはなりません。*/これは、無効にされるコード自体に と 区切り文字が含まれている可能性があるため、コードの一部を と で囲むだけでは無効にできないことを意味し/*ます。*//**/

コメントの文書化

メソッド、変数、またはクラスを文書化するには、テキストを強調表示する特別な方法が使用されます。これは/**と を使用して行われます*/。この場合、コメントされたテキストの各行は で始まります*。メソッドが文書化されている場合は、その引数と戻り値を記述するのが通例です。

/**
* Метод возвращает максимальное meaning
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

他に何を読むべきですか？たとえば、この資料: Java のコメント: すべてがそれほど単純ではありません。または、コメントに関する Java Syntax Pro クエストの レクチャー。