【Java入門】コメントの種類と書き方(Javadocに関する規約も解説)

コメントを記入しておくと、後からプログラムの内容を確認したり、再利用したりする場合にわかりやすくなります。

またJavadoc用のコメントを記述しておくと、自分で作ったメソッドやクラスなどを他の人が利用しやすくなります。

そこでこの記事では、コメントについて以下の内容で解説していきます。


・コメントとは?
・1行コメントの書き方
・複数行コメントの書き方
・Javadocコメントの書き方

今回はコメントについて、わかりやすく解説していきますので、ぜひ参考にしてください!

コメントとは

コメントとは、プログラム実行時に無視される記述のことです。

ですので、プログラムの動作には何の影響もありません。

後からプログラムの内容を確認したり、再利用したりする場合にわかりやすくなるように記述します。

1行コメント

Javaではコメントを1行で書く場合と複数行で書く場合とで書き方が違います。

1行で書く場合は「//」のあとにコメントを記述します。

複数行コメント

複数行で書く場合は「/*」と「*/」の間にコメントを記述します。

Javadocコメント

JavadocとはJavaのソースコードからHTML形式のAPI仕様書を生成するソフトのことです。

Javadocのフォーマットに従って記述しておくと定義したメソッドやクラスを説明するドキュメントをJavadocで簡単に作成することができます。

Javadocコメントを書く場合は「/**」と「*/」の間にコメントを記述します。

1行コメントの書き方

1行コメントの書き方をサンプルコードで確認しましょう。

実行結果:

コメント「ディスプレイに表示するためのメソッド」はプログラムの実行には何の影響も与えていません。

複数行コメントの書き方

複数行のコメントの書き方をサンプルコードで確認しましょう。

実行結果:

Javadocコメントの書き方

Javadocコメントの書き方をサンプルコードで確認しましょう。

実行結果:

下記のようにjavadocコマンドを使うとソースコードからドキュメントを作成することができます。

htmlという名前のフォルダが作成され,ドキュメントがそのフォルダ内に作られます。

フォルダhtml内のindex.htmlをWebブラウザで開くとドキュメントの内容を確認できます。

規約

以下の表のように「@」(アットマーク)がついたタグが用意されています。

タグ説明
@atuthorプログラムの作成者
@version作成したプログラムのバージョン
@paramメソッドの引数の説明
@returnメソッドの戻り値の説明

まとめ

今回はコメントについて解説してきましたが、いかがでしたか?

コメントを記入しておくと、後からプログラムの内容を確認したり、再利用したりする場合にわかりやすくなります。

またJavadoc用のコメントを記述しておくと、自分で作ったメソッドやクラスなどを他の人が利用しやすくなります。

コメントを活用して楽にプログラムが利用できるように、この記事を何度も参考にして下さいね!

Javaカリキュラム無料公開中!

この記事はJava入門完全攻略ガイド【基礎学習/アプリ開発/仕事獲得】の一部になります。このカリキュラムは、プログラミング入門者が、基礎学習からアプリ開発、さらには仕事獲得まで体系的に学べる内容となっています。

Java学習に必要な情報を一つにまとめていますので効率よくJavaを学ぶことが出来ます。この機会に是非活用していただければと思います。

Java入門からアプリ開発まで未経験者が知っておくべき基礎を総ざらい
更新日 : 2019年5月22日

最短でJavaを習得したい方へ

もし、あなたが、

「難しすぎて学習が全然進まない」
「学習量が膨大でゴールが見えない」
「エラーを解決するのに何日もかかってしまう」

など、プログラミング学習やキャリアに関してお困りであれば、まずは『無料体験レッスン』にお申し込み下さい。

あなたにとって、最適の解決策をご提案させていただきます。

詳しくは下の画像から詳しいサービス内容をご確認ください。

cta_bannar-java1
LINEで送る
Pocket

書いた人

長野 透

長野 透

熊本在住のフリープログラマ兼ライターです。C/C++/C#、Java、Python、HTML/CSS、PHPを使ってプログラミングをしています。専門は画像処理で最近は機械学習、ディープラーニングにはまっています。幅広くやってきた経験を活かしてポイントをわかりやすくお伝えしようと思います。
お問合せはこちらでも受け付けています。
[email protected]

おすすめコンテンツ

あなたにぴったりなプログラミング学習プランを無料で診断!

プログラミング学習の効率を劇的に上げる学習メソッドを解説