Bibliotheksfähiger Code 

(Unter „Code“ verstehen wir hier Quelltext einer Programmiersprache.)

Oft werden neben der Anforderung, bestimmte Aufgabe zu erledigen, noch andere Anforderungen an ein Programm gestellt: Beispielsweise soll sein Quelltext so übersichtlich  sein, daß auch noch andere Personen als der ursprüngliche Autor Änderungen daran vornehmen können.

Allgemein kann man zwischen bibliotheksfähigem Code und Ad-hoc-Code unterscheiden:

Bibliotheksfähiger Code

Bibliotheksfähiger Code  wurde unter Beachtung einschlägiger Stilregeln  aufgebaut. Er wird dauerhaft gespeichert und aufbewahrt. Er erfüllt verschiedene Qualitätsanforderung, die es erlauben, ihn in Software-Projekten einzusetzen, die über einen längeren Zeitraum  laufen. Dazu gehört insbesondere ein Aufbau, der so übersichtlich ist, daß man sich gut darin zurechtfindet (um Fehler finden und beseitigen und Änderungswünsche umsetzen zu können), und der es erlaubt, das Programm in eine Bibliothek oder ein größeres Programm  zu integrieren.

Hier sind einige Merkmale, die mit bibliotheksfähigem Code verbunden sein können, aber nicht immer alle zutreffen müssen:

• Fehler im Code können schlimme Folgen  haben.
• Er wird für den wiederholten, dauerhaften Einsatz geschrieben.
• Er wird vermutlich über einen längeren Zeitraum  hinweg von vielen Menschen benutzt, gelesen und überarbeitet werden.
• Der Autor erstellt das Programm beruflich.
• Der Code wird für eine Prüfung  geschrieben, in der die Einhaltung von Stilregeln verlangt oder beurteilt wird.
• Der Quelltext ist relativ groß.
• Das Programm wird von anderen  Menschen als dem Autor benutzt, und der Autor ist bei der Nutzung gar nicht mehr anwesend. Daher kann der Autor eventuell bei der Ausführung auftretende Probleme nicht (sofort) beheben,

Ad-hoc-Code

Wenn Code „nur“ funktioniert, löst er eine aktuelle Aufgabe, aber er erfüllt nicht unbedingt alle Anforderungen, die man an bibliotheksfähigen Code stellt. Er ist oft nicht dafür gedacht, dauerhaft gespeichert und später noch einmal verwendet oder überarbeitet zu werden, sondern ist nur für den Moment geschrieben. Wir nennen solchen Code Ad-hoc-Code  („Wegwerf-Code“ oder „Sonnenschein-Code“ [funktioniert vielleicht nicht mehr, wenn es anfängt zu regnen]).

Manchmal ist es richtig, Code zu schreiben, der nur eine aktuelle Aufgabe löst, aber nicht bibliotheksfähig ist. Beispielsweise, wenn der Code ohnehin nicht längerfristig aufbewahrt werden soll, sondern nur vorübergehend benötigt wird, oder der Zeitrahmen bis zum Abgabetermin nur diese Vorgehensweise erlaubt.

Hier sind einige Merkmale, die mit Ad-hoc Code verbunden sein können, aber nicht immer alle zutreffen müssen:

• Fehler im Code hätten keine schweren Folgen.
• Der Code wird für einmaligen, kurzfristigen Einsatz oder für Übungszwecke geschrieben.
• Der Autor ist Anfänger.
• Es handelt sich um Lehrbeispiele, die zur Erleichterung des Verständnisses möglichst klein und einfach gehalten werden sollten.
• Der Code wird vom Autor nur für sich selber geschrieben und nicht von anderen benutzt, gelesen oder überarbeitet werden, und der Autor ist entsprechend bei der Verwendung des Programms anwesend und kann Probleme deshalb durch eine Überarbeitung des Programms beheben, wenn dies nötig wird.
• Der Quelltext ist relativ klein.

Über Stilregeln

Im weiteren Verlauf des Kurses werden manchmal Stilregeln (Empfehlungen zum Programmierstil) gegeben werden. Diese Stilregeln gelten für größere Software-Projekte, also für Code, der bibliotheksfähig sein soll. Wenn man kleinere Programme schreibt, um ein aktuelles Problem zu lösen oder etwas damit zu vorzuführen oder auszuprobieren, dürfen einige dieser Stilregeln mißachtet werden, wenn solche Programme weder in Bibliotheken eingebaut noch zu größeren Programmen ausgebaut werden sollen. Es kann aber auch sinnvoll sind, diese Stilregeln auch bei kleineren Projekten zu beachten, damit man sich daran gewöhnt, sie anzuwenden und sich dadurch auf größere Projekte vorbereitet.

Wer nur für sich selber Programme schreibt, die später nicht von anderen Menschen überarbeitet werden sollen, darf im Grund dabei auch gegen alle Stilregeln verstoßen, es könnte aber sein, daß er dann später bemerkt, daß er seine eigenen Programme nicht mehr versteht oder diese Fehler enthalten, die durch Beachtung von Stilregeln hätten vermieden werden können.

Stilregel

Stilregel Quelltext soll so geschrieben werden, daß er für andere Menschen (mit den nötigen Vorkenntnissen) möglichst gut und schnell verständlich ist. Daher soll alles so einfach und übersichtlich wie möglich gehalten werden und alles vermieden werden, das Mißverständnisse hervorrufen könnte.

Begründung Programme für spezielle Aufgaben, die mit viel Aufwand erstellt wurden, sollen oft noch Jahre oder Jahrzehnte nach ihrer Herstellung eingesetzt und angepaßt werden. Anpassungen sind aber unmöglich oder zu aufwendig oder fehlerträchtig, wenn ein großes Programm unübersichtlich sind. Wenn solch ein Programm daher dann ganz neu geschrieben werden muß, verringert dies die Produktivität auf anderen Gebieten und verursacht enorme Kosten. Auch die Herstellung eines Programms wird gebremst oder unmöglich und zu teuer, wenn es zu unübersichtlich ist.

Zitate *

Aussage von Grant Edwards

From: Grant Edwards <grant.b.edwards@gmail.com>
Newsgroups: comp.lang.python
Subject: Re: File not closed
Date: Wed, 20 Mar 2019 14:14:46 -0000 (UTC)
Lines: 26
Message-ID: <mailman.207.1553091307.20971.python-list@python.org>

For short, throw-away progams, that's fine.  For long running servers,
it's bad style.
--
Grant Edwards