SE夫婦の背のびしないくらし

Javaコメントの種類とコメントを書く意味とは?コメントアウトって何?

WRITER
 
この記事を書いている人 - WRITER -

プログラムの中に「この処理はこんな機能を持っています」のような説明を見かけると思います。

この説明のことを「コメント」と言います。

Javaプログラムのコメントの種類

種類というと大げさかもしれませんが、3つの種類のコメントの書き方があります。

  1. 1行コメント
  2. 複数行コメント
  3. JavaDoc用コメント

です。

コメントの部分はコンパイルと実行の時に無視されます。

1行コメント

スラッシュ(/)を2つ並べて、それに続けてコメントを書きます。

「//」がついている行のみがコメントの対象です。

複数行コメント

「/*」と「*/」の間に、複数行のコメントを書くことができます。

JavaDoc用コメント

前の2つとはちょっと性質が異なる特別なコメントです。

プログラムについての説明を書くコメントで、「JavaDoc」と言われています。

先頭のアスタリスクが「/**」2つで始まります。

規則に従ってクラス概要やメソッド概要を記述しておくと、その情報からHTML型式のドキュメントファイルを作成することができます。

こんな感じです。

わざわざ別でドキュメントを作る必要がなくなるので便利ですね。

JavaDocコメントはドキュメント用なので、ちょっとしたコメントを書くときには使わないようにしましょう。

コメントを書く意味

どのような処理を行っているか、分かりやすくするためコメントを記述します。

自分だけがメンテナンスするわけではないと思うので、他の人が見ても分かりやすいように書くのがポイントです。

まぁ、コメントがなくても読みやすいコードが書ければ一番なのかもしれないですが。

コメントアウトするとはコメントを書くこと?

どうやら、「コメントアウトする」とはプログラム全般の用語として、「コメント文を書くこと」のようです。

そうなんですね笑

でも、通常業務では

  • コードを一時的に無効化したい場合

などに「コメントアウト」という言葉を使っています。

例えば、デバックするとき、関係ないコードを「コメントアウトする」とか、プログラミングしたけれど今すぐ使わない機能の部分を「コメントアウトする」というような感じです。

ちなみにコメントを外して元のコードに戻すことを「アンコメント」と言います。

使ってみてくださいね🎵

この記事を書いている人 - WRITER -

- Comments -

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

Copyright© ふたりぐらし , 2021 All Rights Reserved.