Delphi Quellcode ordnen

[baumina]

Sieht sehr ordentlich aus, Perlsau, wobei ich persönlich Kommentare wie "On Create" über der Procedure "FormCreate" als nutzlos betrachte.

[Perlsau]

Zitat von baumina:

Sieht sehr ordentlich aus, Perlsau, wobei ich persönlich Kommentare wie "On Create" über der Procedure "FormCreate" als nutzlos betrachte.

Danke, Baumina, endlich weiß das mal jemand zu würdigen

Die Kommentare über den "offensichtlichen" Methoden stehen dort auch nur aus gewissermaßen ästhetischen Gründen und sind davon abgesehen in der Tat nutzlos – oder nein, nicht ganz, denn den Kommentar habe ich immer schneller im Fokus als den Methodennamen. Hab ich aber bereis in meinem Default-Projekt so angelegt und muß daher auch nicht neu getippt werden

Das Ganze sollte auch nur ein Beispiel sein. Die Frage lautete ja: Wie formatiert ihr euren Quellcode?

[Captnemo]

Finde ich ja rein optisch auch sehr schön, und für die Übersicht eigentlich auch nett.
Aber unabhängig von der Sinnhaftigkeit, die ja sowieso im Auge des Betrachters liegt (ist absolut nicht abwertend gemeint), würde mir das persönlich zu viel Zeit kosten, bei jeder Methode eine solche Kommentarzeile einzufügen. Es sei denn, sie enthält tatsächlich Informationen, die ich aus dem Methodenname und den Parametern nicht sowieso rauslesen kann. Zumal ja auch noch die Kommentare dazu kommen, die man sowieso machen sollte.

Wenn sich eine solche Zeile natürlich automatisch erzeugen ließe, dann wäre das was anderes.

[Perlsau]

Es mag für dich auf den ersten Blick so aussehen, als würde ich mit dem Einfügen von Kommentarzeilen unverhältnismäßig viel Zeit verschwenden. In Wirklichkeit kopiere ich einfach eine bereits vorhandene Kommentarzeile und füge sie über der neuen Methode ein. Danach muß ich nur noch den Text ändern (zuvor auf Überschreiben umschalten, damit die Formatierung nicht durcheinanderkommt). Das geht bei mir quasi (halb-)automatisch, weil ich das schon sehr lange so handhabe und beinahe täglich stundenlang am Coden bin.

Die für diese Kommentarzeilen aufgewandte Zeit spare ich dann beim Suchen & Finden einer Codestelle zig-fach wieder ein. Und wie bereits oben erwähnt: Ich verfüge über etliche Default-Projekte, die bereits solche Kommentarzeilen enthalten. Vielleicht sollte ich noch erwähnen, daß ich meine Tastatur blind beherrsche (hatte vor 36 Jahren in der Schule Schreibmaschinen-Unterricht und diese Fähigkeit immer durch Übung gepflegt und ausgebaut). Wenn ich Leuten was am PC zeige, muß ich mich immer bremsen, denn das geht oft so schnell, daß ein Beobachter gar nicht mitbekommt, was ich da gerade gemacht habe.

[jaenicke]

Ich benutze lieber Addons wie CodeExplorer. Da brauche ich keine Kommentare um zu sehen was private ist usw. oder für die Navigation. Das wird automatisch farblich in der Übersicht markiert und ich brauche nur drauf zu klicken um zum Code zu kommen. Das hat den Vorteil, dass ich in fremdem Code, auch dem der RTL z.B. genauso schnell navigiere wie in eigenem.

Ich weiß natürlich nicht wie das bei dir ist, aber ich kenne andere, die auch sehr auf Kommentare und hochspezielle Formatierung setzen, und bei fremdem Code oder beim Debuggen in den Delphi Quelltexten teilweise ganz verloren sind, teilweise extrem langsam sind.

[Perlsau]

Zitat von jaenicke:

Ich benutze lieber Addons wie CodeExplorer. Da brauche ich keine Kommentare um zu sehen was private ist usw. oder für die Navigation. Das wird automatisch farblich in der Übersicht markiert und ich brauche nur drauf zu klicken um zum Code zu kommen. Das hat den Vorteil, dass ich in fremdem Code, auch dem der RTL z.B. genauso schnell navigiere wie in eigenem.

Einen CodeExplorer konnte ich in meinem Delphi2009 nicht finden, und auf der entsprechenden Website wären 100 Euro dafür fällig. Das gibt mein Budget nicht her. Kommt halt immer auch drauf an, in welchem Umfeld man arbeitet bzw. was man mit seiner Arbeit verdient.

Zitat von jaenicke:

Ich weiß natürlich nicht wie das bei dir ist, aber ich kenne andere, die auch sehr auf Kommentare und hochspezielle Formatierung setzen, und bei fremdem Code oder beim Debuggen in den Delphi Quelltexten teilweise ganz verloren sind, teilweise extrem langsam sind.

Das ist in der Tat ein Manko meiner Methode, das kann ich aus eigener Erfahrung bestätigen. Oft ist aber auch bereits ein fast vollständig unkommentierter Fremdcode daran beteiligt, daß es längere Zeit in Anspruch nimmt, ihn zu analysieren. Ich will mich aber von Fremdcode nicht unbedingt dazu verleiten oder bedrängen lassen, meine Formatierungsmethoden gravierend zu ändern oder das Kommentieren so stark einzuschränken, wie ich das gelegentlich bei Fremdcode sehe. Gerade für einen Programmierer, der Fremdcode zu bearbeiten hat, ist es äußerst hilfreich, wenn er bereis am Kommentar sehen kann, was diese oder jene Routine tut. Wie sie's genau tut, muß er dann natürlich im Code selbst herausfinden. Die Empfehlung, sprechende und aussagekräftige Bezeichner auch für Methoden zu verwenden, beherzigen meiner bescheidenen Erfahrung nach noch immer sehr wenige Delphi-Programmierer. Nicht selten würde ein Bezeichner aber auch zu lang werden, wenn man ihn derart umbenennen wollte, daß aus dem Namen bereits die Funktion ersichtich ist. Deshalb, so scheint mir, verwenden viele Abkürzungen, die sie nach ein paar Jahren dann oft selbst nicht mehr auf Anhieb verstehen.

Naja, wie gesagt, dieser Thread soll ja nur, wie ich das verstanden hatte, dazu dienen, Beispiele für Code-Formatierungen zu zeigen. Was da jetzt wem besser oder ungünstiger erscheint, wurde bereits in zahlreichen ähnlichen Threads bis zum Anschlag durchgeackert

Zitat von SyntaxXx:

Was macht ihr, um euren Code übersichtlicher zu gestallten?
Habt ihr ein paar Ratschläge, wie man die Übersicht bewahren kann?

Übrigens muß man die Anmerkung, der eigene Beitrag enthielte keine Kritik, nur dann anbringen, wenn der Beitrag trotzdem Kritik enthält. Nein, ich habe nichts gegen Kritik einzuwenden.

[p80286]

Bevor man sich Gedanken macht, wie Code denn richtig formatiert ist (ist wahrhaftig nicht unwichtig!) sollte man wirklich Dalai's Einlassung ganz, ganz ernst nehmen. Das hat neben der Ordnung und Übersicht, den Vorteil, das ein gut sortierter Werkzeugkasten mit dem was man immer so braucht zur Verfügung steht.

Gruß
K-H