Der TCL Styleguide (deutsch)

Ein Styleguide (oder deutsch Gestaltungsrichtlinie) beschreibt, wie bestimmte Elemente eines Erzeugnisses zu gestalten sind. Diese Richtlinien sollen ein einheitliches Erscheinungsbild gewährleisten, was vorallem durch einheitliche Bezeichnungen, Formulierungen und Sprachstile erreicht wird. Dazu gehören u.a. auch Gliederung, Seitenformatierung, Datumsformate oder andere Gestaltungsmittel.

Bei der Software-Erstellung ist das Ziel, dass das Ergebnis als zusammengehörig wahrgenommen werden und ggf. auch mit der verbundenen Programmiersprache / Technik assoziiert werden soll.

Grundsätzlich sollte jede Prozedur eine Dokumentation haben, welche alle Argumente und den Rückgabewert beschreibt und der Quelltext sollte ein einheitliches Aussehen habenum es für andere Entwickler einfacher zu machen den Quelltext zu benutzen, zu lesen und zu warten. Neben der Dokumentation innerhalb des Quelltext (Kommentare) sollte auch eine zusammenfassende Dokumentation (Readme) der wichtigsten Elemente erstellt werden, sowie Hinweise auf den Autor.

Der TCL Styleguide ist ein Leitfaden für technische und visuelle Aspekte für die Erstellung von TCL Quellcode.

Einführung TCL Styleguide