以下の書き方でいける
$table = $this->table('table_name', ['comment', 'テーブルの説明']);
$table->addColumn('name', 'string', [
'default' => '',
'limit' => 255,
'null' => false,
'comment' => 'カラムの説明'
]);
ドキュメントの運用とか面倒なので、このようにテーブル、カラムコメントで運用してくとやりやすそう。
ちなみに、SQLでコメントを確認すると時は以下のやり方がある。
> show table status like 'table_name';
show full columns from table_name;
(参考) https://qiita.com/snaka/items/28c636214099f3b99c18
もしくは、これ。
> SHOW CREATE TABLE table_name;