Code-Style: wie verschönert/verbessert ihr die Lesbarkeit großer Dateien?

[a.def]

Aktuell bearbeite ich alten Quellcode und hübsche ihn mit Kommentaren und weiteren Dingen auf.

So habe ich mir z.B. angewöhnt große zusammenhängende Code-Passagen folgendermaßen zu markieren und sichtbar vom Rest zu trennen

Delphi-Quellcode:

// Code description ...
// ==============================================================================================================================================
ganz viel code!
// ==============================================================================================================================================

Macht ihr auch soetwas oder eher gar nicht?

Mir hilft Cnpack dabei sehr. Eine Tastenkombination und schon habe ich meinen Block im Editor.

[himitsu]

Delphi-Quellcode:

{$REGION 'Code description'}
ganz viel code!
{$ENDREGION}

:roll:


Und dann könnte man es eventuell mit etwas Refactoring versuchen.

[Luckie]

Mit Kommentaren aufhübschen? Ein Widerspruch in sich. :?

[brechi]

Bei mir gibt es keine großen Dateien. Ganz einfach :)

[BUG]

Zitat:

Zitat von himitsu (Beitrag 1356531)

Und dann könnte man es eventuell mit etwas Refactoring versuchen.

Also praktisch: Aus den zusammenhängenden Code-Blöcken kann eine Funktion (oder ein Objekt) werden. Mit etwas Glück kannst du dir dann ein paar Kommentare sparen, weil du den Funktionen sinnvolle Namen geben kannst.

Zitat:

Zitat von Luckie (Beitrag 1356532)

Mit Kommentaren aufhübschen? Ein Widerspruch in sich. :?

Ich weiß nicht, wenn man sich in Legacy-Code einarbeitet, dann sind ein paar Kommentare/Notizen als erster Schritt sicher nicht die schlimmste Idee.

[Luckie]

Ja. Aber sie sollten nach der Überarbeitung wieder verschwunden sein.

[Sherlock]

Ich bleibe dabei: Kommentare sind nicht überflüssig, und machen auch nichts kaputt. Ich habe letzte Woche vor einem Codestück gesessen, und dachte mir "Was hat dieser Drecksack sich dabei gedacht?" Dazu muss ich folgendes noch erklären:
1. Der Code war zwei Monate alt
2. Der Drecksack bin ich :twisted:

Die entsprechende Stelle war ein äußerst eleganter Zweizeiler, nur leider mußte ich eine gute Viertelstunde darüber grübeln, was ich mir dabei gedacht habe. Was es machen sollte war klar, nur verstand ich nicht mehr wie, und wie ist manchmal schon wichtig... Ein paar erhellende Worte darüber oder daneben hätten mein Zeitkonto etwas schonen können, jetzt haben die grauen Herren sich wieder eine Zigarre auf meine Kosten rollen können ;)

Aber zum Thema: Pro Klasse bzw. Klassenbaum eine Unit, und pro Methode nicht mehr als 50 Zeilen, dann wirds schön übersichtlich.

Sherlock

[Der schöne Günther]

Zitat:

Zitat von Sherlock (Beitrag 1356538)

Pro Klasse bzw. Klassenbaum eine Unit, und pro Methode nicht mehr als 50 Zeilen, dann wirds schön übersichtlich.

Zitat:

Zitat von brechi (Beitrag 1356533)

Bei mir gibt es keine großen Dateien. Ganz einfach :)

So einfach ist das? Ja. 8-)

[EWeiss]

Zitat:

nur verstand ich nicht mehr wie, und wie ist manchmal schon wichtig...

Sehe ich genauso.

Mit unter schreibt man code den man nach Jahren portieren oder nochmal überarbeiten will da man sein wissen verbessert hat.
Da ist es schon hilfreich wenn man vorher ein Kommentar (Sinnvollen) hinterlassen hat.
So was wie "Start der Anwendung" in FormCreate zählt natürlich nicht dazu.

Zitat:

Pro Klasse bzw. Klassenbaum eine Unit, und pro Methode nicht mehr als 50 Zeilen, dann wirds schön übersichtlich.

Dito :thumb:

gruss

[a.def]

Zitat:

Pro Klasse bzw. Klassenbaum eine Unit, und pro Methode nicht mehr als 50 Zeilen, dann wirds schön übersichtlich.

Ich habe irgendwann angefangen thematisch alle meine Prozeduren und Funktionen und eigene Dateien auszulagern.
Ich habe zwar noch immer relativ große Dateien aber wenn man eine eigene Sortierung der Dateien in der Projektverwaltung hätte, würde ich ich viel mehr und viel kleinere Dateien haben.