JavaクラスにJavadocを書いてもらう

最終更新日時

Dec 2, 2024 7:55 AM

ツール

GitHub Copilot

利用シーン

実装/Javaを書く

GitHub Copilot Chatを使い、こちらのコードにJavadocを書いてもらいます。

‣

Javadocを書いてもらいたいコード

エディタで、該当のファイルを開く
Copilot Chat Viewを開く
/doc 日本語でjavadocを書いてくださいと入力し送信
GitHub Copilot Chatにより、元のコードにJavadocを加えた結果が出力される
ファイル(DateRangeValidator.java)の内容を全選択する
Insert at Cursorボタンを押す
ファイルの内容がJavadocを加えた新しいものに置き換わる

‣

最終的に以下のようなJavadocが出力されました

package com.nablarch.example.app.entity.core.validation.validator;

import nablarch.core.util.DateUtil;
import nablarch.core.util.StringUtil;

public class DateRangeValidator {
    private final String start;
    private final String end;

    private final String dateFormat;

    public DateRangeValidator(final String start, final String end) {
        this(start, end, "yyyyMMdd");
    }

    public DateRangeValidator(final String start, final String end, final String dateFormat) {
        this.start = start;
        this.end = end;
        this.dateFormat = dateFormat;
    }

    public boolean isValid() {
        if (isValidDate(start) && isValidDate(end)) {
            return DateUtil.getParsedDate(start, dateFormat).compareTo(DateUtil.getParsedDate(end, dateFormat)) <= 0;
        }
        return true;
    }

    private boolean isValidDate(final String date) {
        if (StringUtil.isNullOrEmpty(date)) {
            return false;
        }
        return DateUtil.isValid(date, dateFormat);
    }
}

package com.nablarch.example.app.entity.core.validation.validator;

import nablarch.core.util.DateUtil;
import nablarch.core.util.StringUtil;

/**
 * 日付範囲のバリデーター。
 * 開始日と終了日を指定し、その範囲が有効かどうかを検証します。
 */
public class DateRangeValidator {
    private final String start;
    private final String end;

    private final String dateFormat;

    /**
     * デフォルトの日付形式（"yyyyMMdd"）を使用して、バリデーターを作成します。
     *
     * @param start 開始日
     * @param end 終了日
     */
    public DateRangeValidator(final String start, final String end) {
        this(start, end, "yyyyMMdd");
    }

    /**
     * 指定された日付形式を使用して、バリデーターを作成します。
     *
     * @param start 開始日
     * @param end 終了日
     * @param dateFormat 日付形式
     */
    public DateRangeValidator(final String start, final String end, final String dateFormat) {
        this.start = start;
        this.end = end;
        this.dateFormat = dateFormat;
    }

    /**
     * 開始日と終了日が有効な範囲であるかどうかを検証します。
     *
     * @return 開始日と終了日が有効な範囲であればtrue、そうでなければfalse
     */
    public boolean isValid() {
        if (isValidDate(start) && isValidDate(end)) {
            return DateUtil.getParsedDate(start, dateFormat).compareTo(DateUtil.getParsedDate(end, dateFormat)) <= 0;
        }
        return true;
    }

    /**
     * 指定された日付が有効かどうかを検証します。
     *
     * @param date 検証する日付
     * @return 日付が有効であればtrue、そうでなければfalse
     */
    private boolean isValidDate(final String date) {
        if (StringUtil.isNullOrEmpty(date)) {
            return false;
        }
        return DateUtil.isValid(date, dateFormat);
    }
}