コードコメント：コード内のセクション見出しに使う小さな FIGlet 文字
コードコメントは、テキストを FIGlet の Small フォントで組み、大文字の高さが 4 行なので、セクション見出しがその下のコードを画面の外へ押し出しません。コードエディターのダークグレーの上にミントグリーンの文字を置き、ほかのコメントの中でバナーがどう収まるかを確認できます。
自分好みに仕上げる
コメントの形式を選ぶ
「エクスポート」メニューでは、「// コメントとしてコピー」が JavaScript、C、Go に、# が Python、Ruby、シェルスクリプトに、/* */ が CSS に向いています。どの形式でも「フォント」と間隔は変わりません。
行の上限内に収める
多くのコードベースでは 1 行を 80 文字か 100 文字までに制限しています。「最大幅」を上限より数列小さく設定すれば、各行の先頭にコメント記号が付いても行に収まります。
よくある質問
ASCII のコメントバナーでコードが壊れることはありませんか？
ありません。各行がコメント行になるか、ひとつの /* */ ブロックの中に収まります。文字の中に */ が現れた場合は分割されるので、コメントが途中で閉じることはありません。行末のスペースは削除されるため、それを警告するリンターも反応しません。