概要
このページでわかること
- コメントの種類と使い方
覚えておきたいこと
- コメントの書き方
コメントとは
- プログラミングでは、処理と関係のないメモをコメントとして残しておくことができる
- 使い方
- どんな処理をしているのかの説明
- プロジェクトで定められているルールに基づいて
- コメントがあることで他の人がコードを読みやすくなる（可読性の向上）
- 時間が経ったあと自分で見返したときにすぐ処理を理解できる
コメントの種類
- 本記事では３種類のコメントの書き方を紹介する
１行コメント
// ここはコメントとして処理されます
複数行コメント
/*
* ここも
* ここも
* ここもコメントとして処理されます
*/
Javadocコメント
/**
*
* 複数行コメントと同じように
* コメントとして処理されます
*/
Javadocコメントは、その他のコメントと同じように実行する際に無視されるという点は同じだが、特定のコマンドを実行することでクラスやメソッドに関する詳細なHTMLドキュメントを作成することができる
- 例えばこんなコードがあってjavadocをつけていると仮定する
コードの例
/**
* このクラスは、ユーザーを表現します。
* <p>
* ユーザーの名前、年齢、およびその他の個人情報を管理します。
* </p>
*/
public class User {
private String name;
private int age;
/**
* 新しいユーザーを初期化します。
*
* @param name ユーザーの名前
* @param age ユーザーの年齢
*/
public User(String name, int age) {
this.name = name;
this.age = age;
}
/**
* ユーザーの名前を取得します。
*
* @return ユーザーの名前
*/
public String getName() {
return name;
}
/**
* ユーザーの年齢を取得します。
*
* @return ユーザーの年齢
*/
public int getAge() {
return age;
}
/**
* ユーザーの名前を設定します。
*
* @param name ユーザーの新しい名前
*/
public void setName(String name) {
this.name = name;
}
/**
* ユーザーの年齢を設定します。
*
* @param age ユーザーの新しい年齢
* @throws IllegalArgumentException 年齢が負の値の場合
*/
public void setAge(int age) {
if (age < 0) {
throw new IllegalArgumentException("年齢は0以上でなければなりません。");
}
this.age = age;
}
/**
* 与えられた名前で新しいユーザーを作成します。
*
* @param name ユーザーの名前
* @param age ユーザーの年齢
* @return 新しく作成されたユーザーオブジェクト
* @throws IllegalArgumentException 名前がnullまたは空の場合、または年齢が負の値の場合
*/
public User createUser(String name, int age) {
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("名前はnullまたは空であってはなりません。");
}
if (age < 0) {
throw new IllegalArgumentException("年齢は0以上でなければなりません。");
}
return new User (name, age);
}
}
- その後下記のコマンドを実行する
javadoc -d [出力ディレクトリ] [ソースファイルまたはパッケージ]
そうすることで画像のようなファイルを閲覧できる
まとめ
- コメントをつけることで可読性を上げることができる
- コメントの付け方には種類がある
- コメントをつける際はショートカットを利用して素早くつける