プロジェクト作成＆JRE(JDK)選択編が完了しました。
作成したプロジェクトにpackageやclassを追加していくことになるのですが、
その前にコメントについて学ぼうと思います。
■コメントとは・・・
コメントとは、プログラムのそばに「どのような処理をするのか」の情報を記載したものになります。
コメントは記載方法が３つありますが、いずれもプログラムの動作に影響はありません。
また、コンパイル時には無視されるので、classファイルには残りません。
コンパイルとは、ソースファイル(.java)をクラスファイル(.class)に変換することです。
コンピュータが実行しやすい形に変換するのでclassファイルの中身はバイトコードです。
また、コンパイルする際に使用するソフトウェアを「コンパイラ」といい、
ソースコードの文法チェックを行い、誤りがあればコンパイルが失敗します。
■コメントアウトの種類
１、
// これは「１行コメント」や「行末コメント」と言います
⇒「ctrl+/」で対象行をコメントアウトするが効率的
（複数行選択して一気にコメントアウト可能）
２、
/*
これは「複数行コメント」や「ブロックコメント」と言います
開始から終了までの間、何行書いても、コメント扱いになります
*/
３、
/**
これは「Javadocコメント」という特別なコメントです
*/
/**
* このように書く場合が多いです
*
*/
１と２の記載内容には特に決まりごとは無く自由なコメントが可能となっています。
とはいえ、実際の現場ではプログラムの内部実装を確認する人に向けたものであることが多いです。
ただ、３の「Javadocコメント」にはルールがありますので以下にまとめようと思います。
■Javadocとは・・・
Javadocとは、クラスやメソッドを利用する人向けのドキュメントです。
■Javadocのドキュメント化
クラスやメソッドを利用する人向けのドキュメントなので、もちろんドキュメントとして生成することができます。
具体的には、プログラムに埋め込まれたJavadocコメントはjavadocコマンドでHTML形式に変換されブラウザで見るといった感じです。
ただ、コマンドと言うくらいなのでオプションが色々あります。ここでは詳しく触れません。
■Javadocのメリット
１、Javadocを読んでもらえれば、自分のコード(クラスやメソッド)を利用する人が実装を見なくても、使い方を理解してもらえるようになります。
例えば、きっと例外はでないだろうといった憶測で利用されることがなくなります。
これにより、思わぬバグ等を防ぐことに繋がります。
２、Javadocを読むことで、標準APIやライブラリを利用する際に以下を事前に確認することができます。
・どのような場合に例外が発生するのか、
・引数にnullを渡すことが許されるのか
など・・・
■Javadocから読み取れること
・クラスやメソッドの仕様
・どのような引数を渡すべきなのか
・どのような状況で例外が発生するのか
・クラスやメソッドが導入されたバージョン
など・・・
■Javadocを書く場所
classや『メンバー』（member）（fieldとmethodをまとめてこう呼ぶ）に対しての説明を書く場合にのみ使用すること。
クラスやメソッドを利用する人向けに書くので当たり前です。
Javadocを生成したときにこのコメントが採用されます。
（Eclipseの場合は対象classやmemberの名前をcursor hoverすると表示される）
「@author」など色んな注釈が用意されている（Eclipseの場合、javadocコメント内でctrl+spaceで一覧が表示される）。
次回は続きをまとめます。