基礎 レッスン12
コメント
//、/* */、/** */ Javadocコメントの書き方
コメントの種類
コメントはコードの説明を書くためのもので、コンパイル時に無視されます。 適切なコメントはコードの可読性を大幅に向上させます。 Javaには3種類のコメントがあります。
//単一行コメント: 行末までがコメント/* */複数行コメント: 範囲内がコメント/** */Javadocコメント: API ドキュメント生成用- コメントは「なぜ」を説明し、「何を」はコード自体に語らせるのが良い慣習
単一行・複数行コメント
基本的なコメントの書き方です。コメントはプログラムの動作に影響しません。
Javaエディタ
Javadocコメント
/** */ はJavadocコメントで、APIドキュメントの生成に使われます。 クラスやメソッドの説明に @param、@return などのタグを使います。
Javaエディタ
良いコメントの書き方
コメントは「なぜそうするか」を説明し、コード自体が「何をするか」を表現するようにしましょう。
Javaエディタ