Textmulch

Früher, in der Uni, schmiss man die Projektoren an, meist zwei, wenn man etwas vergleichen oder gegenüberstellen wollte. Lange wünschte sich der gemeine Entwickler auch so etwas, der vor seinem einzigen, niedrig aufgelösten Bildschirm saß. Da war man dazu verurteilt, ständig zwischen Fenstern hin- und herzuschalten, wenn man Dokumentation und Code benötigte. Oder man scrollte in lächerlich in kleinen IDE-Fenstern herum, um endlich den richtigen Textabschnitt zu finden.
Irgendwann bekam besagter Entwickler einen Bildschirm dazu, was schon sehr half. Dann wurden die Schirme auch noch richtig breit. So breit, dass man Code- und Text-Dateien leicht nebeneinander stellen konnte. Da fehlte nur noch die Synchronisation. Auftritt Docco!

Rocco: Ablauf dokumentiert

Docco ist ein kleiner Dokumentationsgenerator, der im Sinne des literarischen Programmierens

• die enthaltene Texte als HTML-Dokumentation aufbereitet,
• den Code über Syntax-Kolorierung leichter lesbar macht.

Das eine oder andere tun andere Werkzeuge auch, der Unterschied ist, dass Docco beides macht, und die Ergebnisse noch in einer Seite gegenüberstellt. So, dass man Texte und dazu gehörende Code-Abschnitte schön nebeneinander lesen kann. Das benötigt natürlich Breite, aber die ist ja nun vorhanden.

Dass diese Gegenüberstellung eine gute Idee war, beweisen die Portierungen von Docco, das für CoffeeScript/Javascript  gedacht war. Die Abbildung  wurde übrigens mit der Ruby-Portierung Rocco erstellt.

Springen zwischen Kapiteln

Im Augenblick ist diese Art der Präsentation auf einzelne Dateien fokussiert. Zusammenhänge für größere Anwendungen werden nur über Menüs hergestellt, mit deren Hilfe man zwischen den einzelnen Dateien hin- und herspringen kann.  Verglichen mit einem Buch, wären wir hier auf der Ebene der Kapitel. Da fehlt also noch etwas.

Mehr Rocco