Модификатор comment в Laravel

Через полгода в проекте бывает неочевидно, зачем нужно то или иное поле. Комментарий в структуре таблицы помогает другим разработчикам и вам самим. Для этого есть модификатор comment:

<?php
	$table->string('email')->comment('login email');
?>

Текст комментария сохраняется в базе данных вместе с колонкой. Его видно в PMA и других инструментах при просмотре структуры таблицы.

Пример миграции таблицы пользователей с пояснениями к полям:

<?php
	public function up(): void
	{
		Schema::create('users', function (Blueprint $table) {
			$table->id();
			$table->string('name');
			$table->string('email')->comment('login email');
			$table->integer('salary')->comment('monthly salary');
			$table->timestamps();
		});
	}
?>

Комментарии не влияют на работу приложения - это подсказка для людей. Их добавляют к неочевидным полям: кодам, флагам, внешним ключам, служебным числам.

Добавьте в таблице с юзерами комментарий к полю email.

К каким полям в вашем проекте имеет смысл добавить комментарий?