Mein Delphi-Style

[mkinzler]

Zudem weiss man u.U. nach Jahren dies selber nicht mehr so genau.

[stoxx]

in einem schlauen Buch stand mal, dass man nicht das "WAS" dokumentieren sollte, sondern das "Warum"
daran halte ich mich, und bin sehr gut damit gefahren.

außerdem kann man heutzutage ja Kommentare auch wegblenden ...

Algorithmenbeschreibungen halte ich für sehr sinnvoll !
Lässt sich mit $Region wegblenden, und stören nicht

Delphi-Quellcode:

{$REGION  '  Kommentar   Erklärung Algorithmus             '}

// LS = LevelSize
// CS= CalcSize
/// ========================================================================
///
///   LEVELSIZE
///   LIST          ENTRY                          STOP                TARGET
///                       LS       CS                 LS      CS             LS       CS
///   0             -
///   3           +3:1401- 3    |_ =3        -3:1306- 0 |_ = -3     -3:1529- 0    |
///   4           +1:1402- 6    |            -1:1307- 3 |           -1:1529- 0    |_ = 4
///   6           +2:1402- 6    |_ =3        -2:1307- 3 |_ = -3     -2:1528- 4    |
///   8           +2:1403- 10   |            -2:1308- 6 |           -2:1528- 4    |_ = 4
///   9           +1:1403- 10   |            -1:1308- 6 |_ = -3     -1:1527- 8    |
///   10          +1:1403- 10   |_ =4        -1:1309- 9 |           -1:1527- 8    |_ = 2
///   12          +2:1409- 15   |            -2:1309- 9 |_ = -3     -2:1526- 10   |
///   15          +3:1409- 15   |_ =5        -3:1310- 12|           -3:1526- 10   |
///   16          +1:1410- 21   |            -1:1310- 12|           -1:1526- 10   |_ = 6
///   21          +5:1410- 21   |_ =6        -5:1310- 12|_ = -9     -5:1525- 16   |_ = 5

{$ENDREGION}

[stoxx]

Zitat von mkinzler:

Zudem weiss man u.U. nach Jahren dies selber nicht mehr so genau.

genau richtig, das ist mir am Anfang oft passiert, seitdem habe ich gelernt.
Wenn einem das passiert, sollte man sehr über eigene Verbesserungen nachdenken.

[BAMatze]

Hallo an alle,

eigentlich finde ich in erster Linie, sollte man sich in einem Code schnell zurrecht finden können, also auch als außenstehender Programmierer, der den Quellcode sich einfach nur anschaut und vieleicht versucht was draus zu lernen.
Allerdings muss ich auch sagen gerade in Fächern wie Mathematik, Physik, Chemie, Thermodynamik, Mechanik, ... wird häufig festgestellt, dass die Anzahl verfügbarer Zeichen trotz verwendung mehrerer anderer Zeichensätze (z.B. aus dem Griechischen) nicht ausreichen, sich deswegen auch noch auf i,j,k,l, ... zu beschränken, ist meiner Meinung nach ziemleich fragwürdig. So ist z.B. v für einen Physiker die Geschwindigkeit und für einen Thermodynamiker ist es c.
Selbst gut gemeinte Variablennamen wie iLamda (nach ungarischer Notation), finde ich noch nichtssagend, denn die Frage ist, was ist Lamda für den Programmierer???
Ist es die Wellenlänge oder vieleicht die Rohrreibungszahl in der Strömungslehre (Denke dem Threat-Eigner wird gleich auf dem ersten Blick noch die ein oder andere Lamda-verwendung im Bereich der Matrizen einfallen)?
Ich denke sinnvolle Namen zu vergeben, die das Verstehen des Lesers fördern, vorallem wenn sie wie in diesem Forum als Hilfen für Hilfesuchende gemeint sind, ist das A und O und sollten hier von niemanden verunglimpflicht werden, nur weil es ihm persönlich nicht zusagt oder ähnliches.
Und wie viele meiner Vorredner schon bemerkt haben, sind Codeschnipsel mit Variablen wie im Eingangsthreat einfach zu unleserlich.

MfG
BAMatze

[Satty67]

Zitat von mkinzler:

Zudem weiss man u.U. nach Jahren dies selber nicht mehr so genau.

Nach Wochen, nicht nach Jahren erkenne ich schon meine Schapsideen nicht mehr.

Es wird hier etwas zu wenig auf die belange des Standard-Hobby-Programmierers eingegangen. Nahezu perfekter Code im Team entwickelt ist eine Sache... aber denke hier tummeln sich mind. 50% Freizeit- und Hobby-Programmierer, die einfach andere Ansprüche an den Code haben.

[mkinzler]

Auch ein Hobbyprogrammierer sollte seinen Code so verfassen, das er ihn selber später noch versteht und ihn woanders wiederverwenden kann

[Satty67]

Zitat von mkinzler:

sollte seinen Code so verfassen

Soweit die Fähigkeiten reichen... zumindest ich lerne gerne dazu, aber nur solange es ein Freizeitvergnügen bleibt und nicht zur Arbeit wird.

Manchmal werden mir Vorschläge gemacht, die meine Fähigkeiten und Kenntnisse übersteigen. Ich kann nicht alles lernen, Delphi soll ein Freizeit-Spaß bleiben... das schließt auch die Optimierung meiner "Werke" mit ein.

[Hansa]

Zitat von Satty67:

... aber denke hier tummeln sich mind. 50% Freizeit- und Hobby-Programmierer, die einfach andere Ansprüche an den Code haben.

Ich kenne jedenfalls keinen, der sein Hobby nicht möglichst optimal machen will. Der Autonarr wird seinen Manta schon immer polieren, tiefer legen usw. Bevor der mit seiner verdreckten Karre losfährt, bleibt die eher in der Garage stehen, bis sie wieder auf Hochglanz ist. Und der mit den Briefmarken, der wird die mit Sicherheit auch kategorisieren und sie nicht schief und unsortiert in ein Buch einkleben. Und jemand, der Delphi ernsthaft als Hobby betrachtet, der muss solche Masstäbe dann auch bei sich selber anlegen. In diesem Falle also lesbare Programme zu schreiben.

[Daniel]

Um ehrlich zu ein: Ich kann es verstehen, wenn ein Hobby-Entwickler es nicht auf die Spitze treiben will, an einem gewissen Punkt ankommt und sagt "passt schon". Er muss an diesem Punkt nur wissen, dass er nicht alle Möglichkeiten ausgereizt hat - wenn ihn das aber nicht stört, dann hat er seinen Spaß und gut is'.

[Satty67]

Zitat von Hansa:

ernsthaft als Hobby betrachtet, der muss solche Masstäbe dann auch bei sich selber anlegen.

Etwas überzogen, die Ausübung eines Hobby's an strenge Verhaltensregeln zu binden. Ich hab' viele Hobby's und muss in keinem optimale Ergebnisse abliefern. Wer sein Hobby mit Perfektionismus betreiben will, bitte schön, aber ich lass mir da nichts vorschreiben...

@Daniel:
So sehe ich das, irgendwann ist man zufrieden mit seinem Werk, auch wenn es andere nicht wären.