Laravel スキーマのコメントメソッドを活用する

はじめに

Laravelでスキーマを記述するときにコメントメソッドを活用することでA5M2で表示したときにコメントがカラム名として表示できます。
また、テーブルにコメントを追加することでテーブル名が表示できます。

ソースコード

デフォルトではタイムスタンプは$table->timestamps();のようになっていますが分割してコメント付与しています。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('users', function (Blueprint $table) {
            $table->ulid('id')->primary()->comment('ユーザーID');
            $table->string('name')->comment('ユーザー名');
            $table->string('email')->unique()->comment('メールアドレス');
            $table->string('password')->comment('パスワード');
            $table->timestamp('created_at')->nullable()->comment('作成日時');
            $table->timestamp('updated_at')->nullable()->comment('更新日時');
        });

        // テーブルコメント
        DB::statement("COMMENT ON TABLE users IS 'ユーザーマスタ'");
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('users');
    }
};