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

[Daniel]

Zitat:

Zitat von Sherlock (Beitrag 1356538)

[...]und pro Methode nicht mehr als 50 Zeilen, dann wirds schön übersichtlich.

... wenn da nur nicht diese furchtbare Lücke zwischen Theorie und Praxis wäre. ;-)

[Sherlock]

Zitat:

Zitat von Daniel (Beitrag 1356550)

Zitat:

Zitat von Sherlock (Beitrag 1356538)

[...]und pro Methode nicht mehr als 50 Zeilen, dann wirds schön übersichtlich.

... wenn da nur nicht diese furchtbare Lücke zwischen Theorie und Praxis wäre. ;-)

:-D

Wem sagst Du das?

Sherlock

[EWeiss]

Zitat:

wenn da nur nicht diese furchtbare Lücke zwischen Theorie und Praxis wäre.

Die Praxis ist die das bsp. früher unter VB6 ein Limit pro Datei 64K galt.
Was natürlich auf den heutigen stand nicht mehr kontrolliert wird von keinem mir bekannten Compiler.

gruss

[Uwe Raabe]

Zitat:

Zitat von a.def (Beitrag 1356549)

wenn man eine eigene Sortierung der Dateien in der Projektverwaltung hätte

Ich gruppiere meine Dateien im Projekt in Unterverzeichnissen. Damit lässt sich schon so Einiges erreichen.

[ConnorMcLeod]

Wenn man das selbst in der Hand hat, dann ist ja alles kein Problem...
Für Interfaces, Klassen, Konstanten, Resourcestrings, Hilfsfunktionen jeweils eigene Units.
Die Units mglw in Unterverzeichnissen strukturiert speichern.
Funktionen möglichst klein halten, ca. 15-50 Zeilen.
Funktionsköpfe und Klassendefinitionen gut beschreiben.

so weit so gut.

Die unlesbaren kilometerlangen Spaghetticodes erbt man ja meistens von Leuten, die nicht mehr greifbar sind und da sitzt das Problem, dem ich so begegne:

Nach dem ersten Sichten, wie alles zusammenhängt, kommt bei mir erstmal ein Codeformatter dran.
zB "JEDI Code Formatter", mein derzeitiger Favorit.

Danach werden alle Funktionen und Klassen möglichst ausgelagert in eigene Dateien, siehe oben. Die Dateien bekommen selbsterklärende Namen.
Im Zuge dessen werden mittels Refactoring Variablen sprechender benamst, Konstante mit selbsterklärende Namen eingeführt und auch Kommentare ergänzt, aber nicht massiv. Der Sinn sollte sich möglichst durch den Code erschliessen. Meine wirksamste "Waffe" sind Funktionsköpfe, in denen beschrieben wird, was die Funktion macht:

Delphi-Quellcode:

{-----------------------------------------------------------------------------
  Procedure: ColorPercentLighter
  Purpose:   Produce a brighter color value
  Author:    Connor McLeod
  Date:      19.Dez.2016
  Arguments: AColor: start with this colour and make it brighter
             APercent: resulting colour will be APercent brighter than AColor
  Result:    TColor
  Example:   MyControl.Font.Color := ColorPercentLighter(clYellow, 7);
  History:
  Remarks:
  Todo:
-----------------------------------------------------------------------------}

[bernau]

Zitat:

Zitat von Uwe Raabe (Beitrag 1356559)

Zitat:

Zitat von a.def (Beitrag 1356549)

wenn man eine eigene Sortierung der Dateien in der Projektverwaltung hätte

Ich gruppiere meine Dateien im Projekt in Unterverzeichnissen. Damit lässt sich schon so Einiges erreichen.

Habe ich früher auch gemacht. Da ich aber mehrere Projekte habe, die alle die gleichen Units brauchen (300 Stück), hat es mich immer genervt die Suchpfade in jedem Project anzupassen, wenn mal ein neues Verzeichnis zugefügt wurde.

Mittlerweile versuche ich alles in einem Verzeichnis zu halten und verwende immer mehr Namespaces, welche mir die gleiche logische Funktionalität bieten wie Verzeichnisse.

[ConnorMcLeod]

Das klingt ganz nach einer globalen Lib, die in ein eigenes, übergeordnetes Verzeichnis kommt ;-)

[Der schöne Günther]

Bzw. eigenes Repo.

[a.def]

Zitat:

Zitat von bernau (Beitrag 1356567)

Habe ich früher auch gemacht. Da ich aber mehrere Projekte habe, die alle die gleichen Units brauchen (300 Stück)

Bin ich froh, dass ich meine Dateien, welche ich in mehreren Projekten brauche, an einer Hand abzählen kann.

[Uwe Raabe]

Zitat:

Zitat von bernau (Beitrag 1356567)

Da ich aber mehrere Projekte habe, die alle die gleichen Units brauchen (300 Stück), hat es mich immer genervt die Suchpfade in jedem Project anzupassen, wenn mal ein neues Verzeichnis zugefügt wurde.

Units, die direkt dem Projekt hinzugefügt werden (un um die geht es hier gerade), benötigen keinen entsprechenden Eintrag im Suchpfad.

Übrigens könnte man das auch mit einem verlinkten OptionSet vereinfachen.