Craps - If Verschachtelung

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Antworten
BlackJack

@heni63: Bei Kommentaren wird eigentlich das „inline” kommentieren bevorzugt, also Kommentare zwischen den Zeilen und nicht am Ende von Zeilen. Kommentare beziehen sich normalerweise auf den ihn folgenden Quelltext. Dementsprechend ist der Wunsch nach einer extra Spalte ungewöhnlich. Die Zeilenlänge sollte 80 Zeichen nicht überschreiten, da sind zwei getrennte Spalten for Code und Kommentar nicht wirklich gut umsetzbar.

Das klingt auch irgendwie danach als hättest Du zu viele Kommentare. Die sind dazu da um dem Leser Sachverhalte zu erklären, die aus dem Quelltext selbst nicht ersichtlich sind. Deshalb kann man ganz grob sagen, dass der Quelltext wahrscheinlich schlecht oder zumindest sehr/zu kompliziert ist, je mehr Kommentare man dazu schreiben muss. Es gibt zwar seltene Fälle in denen Algorithmen etwas kniffelig und trickreich sind, dass man mal etwas mehr erklären muss, aber das ist eher selten.

Wenn man es *wirklich* übertreiben will, dann gibt es das sogenannte „literate programming” wo man eher Quelltext in eine Fliesstextdokumentation einbaut statt Kommentare in Quelltext. Ein Beispiel kannst Du Dir hier anschauen: http://marc.rintsch.de/simpledb/

Die *.txt und die *.py.txt sind gleichwertig, dass heisst sie enthalten die selbe Information nur etwas unterschiedlich formatiert. Mit dem Werkzeug `pylit` kann man zwischen den beiden Repräsentationen in beide Richtungen konvertieren. Das *.html und *.pdf sind aus der *.txt erzeugt worden. Beim PDF kommt man so immerhin auf 17 DIN A4 Seiten Text. :-)
Antworten