ASCII-Banner für Quellcode und README
Mach aus einem kurzen Namen eine Überschrift, die in Datei oder README auffällt. Als Kommentare umhüllen, in der Breite halten, kopieren.
Einstellungen
Tipps
Ein kurzer Name, kein Satz
Das Banner ist ein Gitter winziger Zeichen, die große Buchstaben formen. Ein Name so kurz wie Funktion oder Datei — init, main — hält die Formen lesbar. Ein ganzer Satz verbraucht so viele Zellen, dass das Wort nicht mehr zu erkennen ist. Zwei Wörter? Auf zwei Zeilen, damit jedes groß bleibt.
Kommentarzeichen zählen zur Zeilenbreite
Als Kommentare umhüllt, bekommt jede Zeile extra Zeichen wie // und Einrückräume. Der Editor zählt sie mit. Bleibt die Datei bei 80 Zeichen pro Zeile, setze die Breite auf 80. Hier kann es passen und nach dem Einfügen trotzdem überstehen. An Breite anpassen verkleinert, bis der kopierte Block in das Limit fällt.
In einem /* */ beendet */ in der Zeichnung den Kommentar
In C und Java läuft ein Kommentar von /* bis zum ersten */. Zeichnet die Füllung * und / nebeneinander, wird der Rest als echter Code gelesen. Diese Seite setzt ein Leerzeichen dagegen. Füllen mit # oder . zeichnet das Paar nie. Jede Zeile mit // hat kein Endezeichen.
README und Quelldateien erlauben nicht dieselben Zeichen
Ein README nimmt meist jedes Zeichen. Manche Source-Trees — Linux-Kernel-Stil, ältere Checker — nur englische Buchstaben und Symbole. Flächen wie █ lesen sich im README klar und werden dort abgelehnt. Vor dem Einfügen dort ASCII only einschalten und den Namen mit englischen Buchstaben schreiben.
Auch als Kommentar in achtzig Spalten bleiben
Zwischenräume zwischen Buchstaben ändern den Eindruck. Zusammen mit den Zeichen, die daraus einen Kommentar machen, ist die 80-Spalten-Marke schnell überschritten. Auf das Budget achten.
Häufige Anwendungsfälle
Oben in einer Quelldatei
Setze einen kurzen Modulnamen oben in eine .c- oder .py-Datei, als Kommentare, 80 Zeichen pro Zeile. Es ist gewöhnlicher Text, der Diff zeigt dieselben Buchstaben.
Als Überschrift eines README
Öffne ein GitHub-README mit dem Projektnamen als Banner. Im Codezaun brauchst du keinen Bildhost und keinen Link, der bricht, wenn die Datei umzieht.
Wenn das Terminal aufgeht
In die Login-Meldung, eine Shell-Startdatei oder tmux einfügen. Eine SSH-Sitzung zeigt kein Bild; diese Buchstaben schon.
Einen Abschnitt im Skript markieren
Setze ein kompaktes Banner über ein Makefile-Target oder ein Deploy-Snippet. Keine GUI-Schrift — nur Zeichen, die schon in der Datei leben.
In der Pull-Request-Beschreibung
Geht die Änderung um einen benannten Befehl oder eine Binary, setze ein umzäuntes Banner in die Pull-Request-Beschreibung. Reviewer sehen dieselben Buchstaben in jedem Client.