ASCIIバナー生成(ソースコード・README)
短い名前を、ファイルや README で目立つ見出しにする。コメントで包み、桁に収めてコピーする。
設定
ヒント
長い説明ではなく、短い名前を入れる
バナーは、小さな文字のマスを並べて大きな字形を作ります。関数名やファイル名くらい短いもの(init、main)なら、その字形が読めます。説明の一文を入れるとマスが足りず、何と書いてあるかわかりません。二語使うなら、改行して二段にし、それぞれが大きく残るようにします。
コメント記号も、1行の幅に含まれる
コメント化すると、各行の先頭に // や字下げの空白が付きます。エディタの桁数えは、それも含めます。ファイルを1行80字に揃えているなら、予算も80にします。ここでは収まって見えても、貼ったあと右に飛び出すことがあります。フィットは、コピーする塊がその幅に入るまで小さくします。
/* */ で包むと、絵の中の */ でコメントが終わる
C や Java では、/* から最初の */ までがコメントです。塗りが * と / を隣り合わせに描くと、そこから先はコードとして読まれます。このページは間に空白を入れて防ぎます。塗りを # や . にすれば、その並び自体が出ません。各行を // で始める包み方には、この終わり記号はありません。
README とソースでは、使える文字が違う
README は普通、どんな文字でも置けます。カーネル向けや古い検査のソースは、英語の文字と記号だけしか受け付けないことがあります。█ のような塗りは README では見やすいですが、そういうソースでは弾かれます。そちらへ貼る前に ASCII のみをオンにし、名前も英語の綴りにします。
コメントにしても、1行は80桁が目安
文字同士の空白を使うと印象は変わりますが、コメント化用の文字と組み合わせると、80桁は簡単に超えます。その点に注意が必要です。
よくある使い方
ソースの先頭に置く
.c や .py のいちばん上に、短いモジュール名をコメントとして置きます。普通の文字なので、差分にも同じ字が出ます。1行80字のファイルなら、予算も80にします。
README の見出しにする
リポジトリの README を、プロジェクト名のバナーで開けます。上下フェンスで囲めば、画像の置き場も、ファイルが動いたあとの切れリンクも要りません。
端末を開いたときに出す
ログイン時のメッセージ、シェルの起動ファイル、tmux に貼ります。遠くの SSH では画像は出ませんが、この文字は出ます。
スクリプトの区切りにする
Makefile のターゲットや、デプロイ用の断片の上に小さなバナーを置きます。画面用の飾り文字は使わず、ファイルの中の文字だけで区切ります。
プルリクエストの説明に置く
名前の付いたコマンドやバイナリの変更なら、説明文にフェンス付きバナーを置けます。レビューする人の画面が違っても、同じ文字が見えます。