Tipp für Software-Entwickler
Ein Softwareprojekt, das bereits viele Jahre lang aufgebaut und weiterentwickelt wurde, erreicht oftmals eine unglaubliche Dimension.
Große Features, zahlreiche Change Requests, die persönliche „Handschrift“ jedes Entwicklers – die Zahl der Codezeilen steigt mit der Entwicklung einer Software. Für Entwickler gilt es, stets einen Überblick über viele wichtigen Informationen und ein – unter Umständen – riesiges Datenmodell zu behalten. Besonders für neue Kollegen kann der Einstieg in ein über viele Jahre laufendes Projekt schwierig sein.
Wir haben einen Tipp für jeden Entwickler, der sicherstellen möchte, dass er auch nach vielen Monaten der Entwicklung einfach und schnell wichtige Informationen aus der Dokumentation herauslesen kann und jüngeren Kollegen den Einstieg in das Projekt erleichtern möchte: ASCII-Art!
ASCII-Zeichnungen in der Dokumentation
ASCII steht für „American Standard Code for Information Interchange“. Wie der Name bereits verrät bezeichnet ASCII einen Zeichen-Standard für Textdaten und den Informationsaustausch.
ASCII-Art ist eine Kunstrichtung, die mithilfe von ASCII (also mithilfe von Buchstaben, Ziffern und Sonderzeichen) ganze Bilder darzustellen versucht – und genau diese ASCII-Zeichnungen können Entwicklern dabei helfen, wichtige Informationen in der Dokumentation zu verbildlichen und somit einfacher verständlich darzustellen.
ASCII-Zeichnungen in der Dokumentation – Ein Beispiel
So würde wohl ein Kommentar mit ergänzenden Informationen im Code im Normalfall aussehen:
/**
* Return all costumers that are not marked as deactivated
*
* @param allOfThem the list with all costumers
* @return list of costumers that are not marked as deactivated
*/
Doch Bilder sind aussagekräftiger als Worte. Und besonders, um Papierstapel mit Notizen im Büro zu vermeiden, empfiehlt es sich, die Bilder mit ASCII Zeichnungen direkt in die Dokumentation zu integrieren:
Codeautor
David
„Es lassen sich allgemein auch binäre Bilder einbinden, der große Vorteil von ASCII-Zeichnungen ist jedoch die Möglichkeit, das Bild ohne weitere Werkzeuge/Arbeitsschritte sehen zu können. Außerdem können ASCII-Zeichnungen zusammen mit dem Code in der Versionsverwaltung geführt werden.“
Achtung nicht vergessen! Wenn sich das Datenmodell ändern sollte, muss die ASCII-Zeichnung immer entsprechend angepasst werden, um zukünftige Missverständnisse zu vermeiden.
Es gibt übrigens einige Websites, die das Zeichnen mit ASCII erleichtern. Schau Dir zum Beispiel asciiflow.com an.
