Darstellungsform Programmcode in einem Buch

7 Beiträge16.12.2006Archiviert
Marc Ruef16.12.2006 · Beitrag #11122
Admin
Avatar
Mitglied seit: 25.01.2005
Forenbeiträge: 1337
Besuche: 22158
Hallo,

Wie einige Wissen, schreibe ich nach wie vor fleissig an meinem Buch. Mittlerweile habe ich 90 % fertiggeschrieben und widme mich unter anderem den ersten Detailkorrekturen, bevor das Manuskript an die Fachlektoren geht.

Dabei habe ich ein zentrales Problem, zu dem ich gerne Input haben moechte. Und zwar bespreche ich sehr viele Programmquelltexte. Sei dies nun, um das Prinzip einer angegriffenen Applikation zu verdeutlichen, effektive Programmierfehler komplementaer zu diskutieren oder halt allgemein das Prinzip von Quelltext-Analysen zu behandeln.

Die Frage ansich ist, wie ein solcher Programmcode bestmoeglich abgedruckt werden soll, so dass er a) logisch, b) effizient und c) uebersichtlich bleibt. Meines Erachtens ist das Erreichen ALLER Ziele leider nicht moeglich. Hier die Varianten an einem Pseudocode-Beispiel:

Logisch (Perl-Stil): Sammeln der Daten in $output und zentrale Ausgabe zum Schluss
[command]if($INPUT == 1){
$output = "Die Eingabe war gleich 1";
}else{
$output = "Die Eingabe war ungleich 1";
$output.= "Sie war naemlich $INPUT";
}

echo "Das Resultat ist:"
echo $output;[/command]

Uebersichtlich (PHP-Stil): Sofortiges Ausgeben der jeweiligen Daten
[command]echo "Das Resultat ist:"
if($INPUT == 1){
echo = "Die Eingabe war gleich 1";
}else{
echo = "Die Eingabe war ungleich 1";
echo = "Sie war naemlich $INPUT";
}[/command]

Jenachdem ergeben sich eben andere Probleme. Bei der ersten Version muss sich der Leser quasi merken, was in welcher Variable geschrieben wurde und damit, was in der zuletzt ausgegebenen Variable als Inhalt erarbeitet wurde. Besonders bei komplexem Programmcode (viele Entscheidungen) wird das schwierig. Bei der zweiten Version hingegen muss sich der Benutzer merken, was schon ausgegeben wurde. Dies wird besonders bei langem Programmcode muehsam.

Bye, Marc
analyzer16.12.2006 · Beitrag #11123
Mitglied seit: 27.01.2005
Forenbeiträge: 417
Besuche: 4775
Guten Morgen Marc

Ich persönlich würde die sofortige Ausgabe der jeweiligen Daten wählen. Für mich ist dies einfach übersichtlicher.
Von einigen IDE's her kenne ich die Möglichkeit des Einrückens. Ich verwende dies sogar, wenn ich in einem mormalen Editor programmiere.
http://weblog.burgernet.org/uploads/code1.jpg
creepymind16.12.2006 · Beitrag #11124
Avatar
Mitglied seit: 11.01.2006
Forenbeiträge: 328
Besuche: 1562
Hallo,

im Prinzitp wäre auch eine gewisse Dokumentierung des Quelltextes wünschenswert, um erstens bestimmte Schwachstellen gleich kenntlich zu machen bzw. zweitens es dem Leser einfacher zumachen den Code zu lesen/verstehen, da nicht jeder der dein Buch lesen wird auch in der Programmierung "begabt" ist.

Desweiteren kannst du ja auch mit fettgedruckter oder kursivgedr. usw. Schrift arbeiten....ich weiß ja nicht in wie weit du dies bereits bedacht hattest.

Die Umsetzung der Anmerkung von analyzer würde auch ich sehr begrüßen, da ich auch meist in diesem Stil programmiere, weil es um ein vielfaches einfacher/übersichtlicher ist.

greetz lars
[ Bearbeitet Sa, 16. Dez 2006, 09:50 ]
squeez16.12.2006 · Beitrag #11125
Mitglied seit: 06.04.2005
Forenbeiträge: 687
Besuche: 668
Guten Tag

Die meisten Algorithmen arbeiten so, dass sie zuerst etwas berechnen und danach die Ausgabe produzieren.
Es gibt naemlich etwas was man beachten muss. Sollte der Algorithmus durch einen Fehler ( fehlerhafte Daten zum Beispiel ) die Ausgabe nicht berechnen koennen, muss er eine Fehlermeldung ausgeben.
Wenn ein Mensch vor dem Rechner sitzt ist dies nicht weiter tragisch. Wird die Ausgabe jedoch durch ein anderes Programm als Eingabe weiterverarbeitet ( unter UNIX an der Tagesordnung ) macht es mehr Sinn, einen Fehler zu Beginn zu melden, und nicht irgendwo mitten in der Ausgabe.

Das ist ein Punkt welcher fuer die 'logische' Ausgabe spricht.

Ein weiterer Punkt im Zusammenhang mit Code.
Ich weiss nicht wie du es hast, aber ich hasse es, wenn die Sprache im Code staendig hin und her switcht. Wenn einmal englische und einmal deutsche Variablennamen oder gar ein Mix daraus verwendet wird ( ihr wuerdet nicht glauben wo man solchen Code antrifft ! ).

Ein einfaches Syntaxhighlighting ist ebenfalls empfehlenswert ( aber wirklich nur ganz diskret ).

hth

Marco
Marc Ruef16.12.2006 · Beitrag #11127
Admin
Avatar
Mitglied seit: 25.01.2005
Forenbeiträge: 1337
Besuche: 22158
Hallo,

Danke fuer die Hinweise. Also das Einruecken und detaillierte Beschreiben der Quelltexte ist natuerlich schon angedacht. Es wird lediglich hier im Forum nicht korrekt dargestellt ... Dieses verda**te Parsing, dem ich mich mal endlich annehmen sollte ;(( !

In Buechern bin ich nicht so ein Fan von umfassenden Syntax-Spielereien. Irgendwie verzerrt das schnell das Schriftbild. Doch gerade bei komplexen Quelltexten waere sowas, zum Hervorheben der zentralen Elemente, schon von Vorteil. Ich werde das sicher mit meiner Lektorin bespechen ... Die hat da mehr Erfahrung weder ich.

Ich werde mich wohl fuer die logische Abarbeitung (zuerst Berechnen, dann Ausgeben) entscheiden. Wie squeez schoen gesagt hat, ist das eigentlich die einzig richtige Herangehensweise. Die anderen Punkte versuch ich mir natuerlich auch zu Herzen zu nehmen!

Bye, Marc
duddits17.12.2006 · Beitrag #11136
Avatar
Mitglied seit: 07.03.2006
Forenbeiträge: 259
Besuche: 1572
Hi,

mir gefällt erlich gesagt auch logische Stil besser da man daran besser Fehler oder ähnliches erkennen kann und versteht einfach den Zusammenspiel/hang von Programm-Elementen/Teilen besser.

mfg

duddits
ports20.12.2006 · Beitrag #11189
Mod
Avatar
Mitglied seit: 31.01.2005
Forenbeiträge: 705
Besuche: 4459
Obwohl es ja soweit entschieden ist... Aber ich finde auch, dass eine
Logische Struktur angenehmer zu lesen ist. Ich muss sogar zugeben, dass
ich die von dir angefuehrte Uebersichtliche Struktur noch nirgends
gesehen habe. Aber evtl. habe ich bis dato immer die falschen Buecher
gelesen :)

ports