KENスクールブログ | パソコン教室・パソコン講座なら個別指導のKENスクール

BLOGKENスクールブログ

  1. KENスクール TOP >
  2. KENスクールブログ > プログラム > Javaの基礎【コメント】

プログラム

Javaの基礎【コメント】

KENスクールの動画配信サービス「KEN×ONLINE」

コメントとは、コンピュータがプログラム実行時に無視する文字列のことです。
プログラムの実行時には、無視されるため、実行時には意味を持ちません。

複数人でシステムを開発していた場合、作成したソースコードを別の人が読んだとき、
また、同じ人であっても時間をおいてから読んだりした場合には、その意図を読み取ることが困難なことがあります。
その為に、コードの意図をコメントとしてソースコードに挿入することが役立ちます。 

Javaのコメントは行コメント、ブロックコメント、ドキュメントコメントの3種類があります。

行コメント

行コメントは「//」を使用します。プログラム中に「//」が現れた場合「//」から行末までをコメントとして扱います。

行コメントは主に変数の説明、メソッド内の処理の説明で使用します。

ブロックコメント

「/* */」を使用します。プログラム中に「/*」が現れた場合、次に「*/」が現れるまでの部分を全てコメントとして扱います。

ブロックコメントは処理の説明や問題のありそうな場所を一旦無効にして実行したいとき等に使用します。

ドキュメントコメント

「/** */」を使用します。プログラム中に「/**」が現れた場合、次に「*/」が現れるまでの部分を全てコメントとして扱います。

ドキュメントコメントは主にクラス、フィールド、メソッドの説明に使用します。コメントの範囲はブロックコメントと同じですが、決められたルールに従って記述すればクラスのAPI(クラスの使用方法、説明が記述されたドキュメント)が自動生成することができます。

また、クラスの説明やメソッドのコメントには「@」から始まるアノテーションを使用することになりなります。どのアノテーションを使用するかは、開発のプロジェクト毎に決めていることもあり、開発前に決めていたほうが望ましいでしょう。

上記サンプルで使用しているアノテーション

  • @author クラスの作成者を記述する
  • @param メソッドの引数の説明を記述する
  • @return メソッドの戻り値の説明を記述する

 

この記事に関連する講座

エンジニア業務に必要な開発現場のリアルを身につけます。

詳しくはこちら