Einrücken ::: ::: Wie rückt ihr ein?

[Mydoene]

Hi Leutz,
ich hab' da mal 'ne Frage: Wie rückt iht ein? Also eher so:

Delphi-Quellcode:

procedure Button1.Click(Sender: TOBject);
  begin
    If 1>0 then 
      begin
        Application.Terminate;
      end;
    Label1.Caption := 'Mich gibt's nicht!'
  end;

oder eher so:

Delphi-Quellcode:

procedure Button1.Click(Sender: TOBject);
begin
  If 1>0 then 
  begin
    Application.Terminate;
  end;
Label1.Caption := 'Mich gibt's nicht!'
end;

oder vielleicht so (?):

Delphi-Quellcode:

procedure Button1.Click(Sender: TOBject);
begin
If 1>0 then 
begin
  Application.Terminate;
end;
Label1.Caption := 'Mich gibt's nicht!'
end;

Oder macht ihr was total Anderes?
Würde mich auf Antworten freuen, ein Freund und ich streiten uns nämlich um die "bessere" Formatierung. Ich weiß, dass es keine "richtige" Formatierung gibt, will einfach nur subjektive Mehrheiten.

[Kevin]

Eher so wie in Deinem ersten Beispiel.

[SirThornberry]

eigentlich keine von den vorgezeigten Varianten. Bei mir gehört ein begin-end immer in die gleiche Einrücktiefe wie der dazugehörige Kopf (worauf sich das begin-end bezieht). Wenn ein Begin-End vorbei ist kommt bei mir die nächste Anweisung auf die gleiche Höhe wie der begin-end block. Also genau wie bei einer Baumstruktur (nur das man im Baum kein Begin-End sieht).
Also alles was innerhalb eines anderen Zweiges (begin-end) liegt wird eingerückt. Und das nächste Sibbling (Folgenanweisung) hat die gleiche Einrückung wie der vorhergehende Befehl/Befehlsblock.

[fwsp]

ich find den style-guide von dsdt.info dabei sehr hilfreich.

http://www.dsdt.info/grundlagen/styl...nweisungen.php

[SirThornberry]

bei Borland gabs auch einen Styleguide an den ich mich so ziemlich halte.

[fwsp]

Zitat:

Zitat von SirThornberry

bei Borland gabs auch einen Styleguide an den ich mich so ziemlich halte.

kannst du den mal bereitstellen?

[sakura]

Zitat:

Zitat von fwsp

kannst du den mal bereitstellen?

Schon mal gegoogelt?
http://bdn.borland.com/article/10280

...:cat:...

[fwsp]

Zitat:

Zitat von sakura

Zitat:

Zitat von fwsp

kannst du den mal bereitstellen?

Schon mal gegoogelt?
http://bdn.borland.com/article/10280

...:cat:...

immer soll man alles alleine machen. :wink:
das "gab" brachte mich zu der annahme, es gäbe diesen artikel nicht mehr.

[RavenIV]

Also hier in der Firma halten sich alle 12 Entwickler an den Styleguide von Borland.
Wobei sich dieser ziemlich mit dem von dsdt.info deckt.

So ist gewährleistet, dass man sich auch sofort in Code von Borland-Dateien zurechtfindet.

[rwachtel]

Zitat:

Zitat von RavenIV

[...] Styleguide von Borland.
Wobei sich dieser ziemlich mit dem von dsdt.info deckt. [...]

Kein Wunder, da es sich nur um eine Übersetzung handelt... :mrgreen:

[Phoenix]

Wichtig ist nur, dass man Anstelle der 2 Leerzeichen bitte mit Tabs einrückt. Da gabs schon Seitenlange Diskussionen, letzlich hat sich aber immer gezeigt dass Tabs nur Vorteile haben.

Dazu sollte aber auch eine Forensuche die ganzen Argumente auflisten.

[_frank_]

habe die Forumsuche ausnahmsweise mal ausgelassen wegen dem Statement "dass Tabs nur Vorteile haben".
tabs müssen z.B. immer konfiguriert werden, wenn du mal einen anderen Editor nimmst ist die Tabweite eigentlich immer mehr als 2 Leereichen (teilweise kann man das gar nicht konfigurieren => Windows-Editor)
Ich für meinen Teil nehme immer 2 leerzeichen und bei tab werden 2 leerzeichen eingefügt.
Das sieht dann in jedem Editor gleich aus, was bei Tab nicht der Fall ist. Und das ist für mich ein entscheidender Nachteil von Tabs...

Gruß Frank

[Elvis]

Zitat:

Zitat von _frank_

Das sieht dann in jedem Editor gleich aus, was bei Tab nicht der Fall ist. Und das ist für mich ein entscheidender Nachteil von Tabs...

*Möööp* Sechs, setzen...
Genau das ist der Punkt warum man ein Zeichen benutzt, dass unabhängig von seiner Darstellung dafür gedacht ist einzurücken: Jeder kann es so breit einstellen wie er will.
Dämlicherweise füllt der Delphi Editor einfach alle white spaces am Anfang einer Zeile mit Tabs auf.
Dadurch kann man zwar gerne Tabs in Delphi Code nehmen, aber den Delphi Editor darf man dann nicht mehr benutzen.

zum Bleistift:

Delphi-Quellcode:

begin
   DoSomething(param1,
               param2,
               param3,
               param4,
               param5,
               param6);
end;

Ich habe die Blockeinrückung mit je einem Tab gemacht (die hier dummerweise 3 Zeichen breit sind), die Einrückung der Parameter natürlich mit Spaces (neben den Tabs).
Egal wie breit Tabs in irgendeinem Editor eingestellt sind, es sollte immer so aussehen, wie es soll.
Wenn Delphi aber alle white spaces am Anfang der Zeile in Tabs umwandelt sieht es einfach nur zum Kotzen aus.

[Phoenix]

Zitat:

Zitat von _frank_

tabs müssen können z.B. immer nach belieben konfiguriert werden, wenn du mal einen anderen Editor nimmst ist die Tabweite eigentlich immer mehr als 2 immer genau der persönlichen Vorliebe entsprechende Anzahl an Leereichen

Und den Windows-Editor nimmt doch niemand ernsthaft zum Öffnen von Quellcode-Dateien. Entweder, die Dinger gehen eh automatisch in der IDE auf (und die ist richtig Konfiguriert), oder aber man hat UltraEdit / PSpad (das Gleiche in Freeware) oder einen anderen Editor drauf der richtige Einrückungen und Syntax-Highlighting hat. Das Argument zieht bei keinem einzigen Entwickler.

Zitat:

Zitat von _frank_

Ich für meinen Teil nehme immer 2 leerzeichen und bei tab werden 2 leerzeichen eingefügt.

Du willst jedem anderen Entwickler im Team diktieren wie breit seine Einrückung sein soll? Überzogen ausgedrückt heisst das: Teamfähigkeit = Null. (Ist übrigens in einigen Firmen die ich kenne sogar schon ein Abmahnungsgrund, aber das nur am Rande.)

Zitat:

Zitat von _frank_

Das sieht dann in jedem Editor gleich aus, was bei Tab zum Glück nicht der Fall ist.

Was ist mit Entwicklern, die z.B. aus Gründen der Übersichtlichkeit bei größeren Blöcken zum Teil Einrückungen von 7 oder sogar mehr Zeichen einsetzen? Linux-Kernelcode hat für Code-Reviews eine Tab-Einrücktiefe von 8 Zeichen und maximal drei Einrückunsgebenen. Es gibt Firmen, die solche ähnlichen Styleguides auch einsetzen.

Im übrigen ist es erwiesen, dass eine Einrückung erst ab mindestens 3 Zeichen intuitiv vom Auge als eine solche erkannt wird (das war eine Ergonomiestudie). Weniger ist nicht intuitiv erkennbar und kann bei tieferen Einrückungen (2-4 Ebenen) schonmal leicht verwechselt werden.

Zudem braucht ein Tab immer nur genau 1 Byte und Einrückungen um n-Zeichen genau n Bytes pro Einrückung. Das macht bei vielen Änderungen an Umfangreichen Sourcen mit einigen Einrückungen dann irgendwann tatsächlich mal was aus in der Masse. Vor allem Versionierungssysteme werden es früher oder später Danken.

Leerzeichen bei Einrückungen sind daher ein absolutes No-Go. Es gibt für Leerzeichen nur Nachteile und für Tabs ausschliesslich Vorteile - und das bei rein objektiver Betrachtunsgweise.

[Sidorion]

Na da scheiden sich mal wieder die Geister. In meiner Firma ist es z.B.: verboten, mit Tabs einzurücken, da es bei uns durchaus vorkommen kann, dass man mal an einem anderen Arbeitsplatz sitzt und dort auch genau die gleichen Einrückungen vorfinden muss.

Dieser Punkt sollte also keinesfalls als Gesetz verstanden werden und jeder kann es so machen, wie er denkt, solange alle im Team auf die gleiche Weise arbeiten. Und dafür gibt es ja die Entwicklerrichtlinien, die jede Firma festlegen sollte.

[SirThornberry]

Die Einrückung ist leider in den Editoroptionen beim BDS2006 nicht auf Tabs gestellt per Default. Und um nachträglich das zu ändern muss man mit dem Cursor durch jede Zeile wandern.
Aber ob Tabs verwendet werden oder nicht wird im Borland-Styleguide nirgends erwähnt, zumindest hab ich beim überfliegen nix gefunden. Letztendlich kann man auch Tabs nehmen und diese dann einfach mal mit suchen->ersetzen durch leerzeischen ersetzen wenn diese unerwünscht sind. Umgekehrt kann mans auch machen. Sofern die Weite der Einrückung am Styleguide angelehnt ist kommt es dann auch nicht zu Problemen (wenn also eine umgebrochene Anweisung genau so weit eingerückt wird wie jede andere Einrückung)

[rwachtel]

Zitat:

Zitat von SirThornberry

[...] Aber ob Tabs verwendet werden oder nicht wird im Borland-Styleguide nirgends erwähnt, [...]

Zitat:

Zitat von Object Pascal Styleguide

4.3 Indentation

You should always indent two spaces for all indentation levels. In other words, the first level of indentation is two spaces, the second level four spaces, the third level 6 spaces, etc. Never use tab characters.

[SirThornberry]

ok, das würde dann erklären warum per default im BDS eingestellt ist das Tabs durch leerzeischen ersetzt werden.

[Mydoene]

Aha! Endlich ist eine Antwort gefunden! Gut, damit ist mein Problem wohl gelöst. Wenn es sogar einen Kodex dafür gibt, wie man zu formatieren hat... ^^

Thx, kann geclosed werden!

[SirThornberry]

Zitat:

Zitat von Mydoene

Aha! Endlich ist eine Antwort gefunden! Gut, damit ist mein Problem wohl gelöst. Wenn es sogar einen Kodex dafür gibt, wie man zu formatieren hat... ^^

Thx, kann geclosed werden!

Wir lassen es weiter offen. Vielleicht ergibt sich aus der Diskussion heraus noch das ein oder andere was praktisch gar nicht Anwendbar ist. Zudem haben wir durch Diskussion bisher raus gefunden welche Vor- und Nachteile einiges hat und wie verschieden es in der Praxis gehandhabt wird.

[Elvis]

Zitat:

Zitat von SirThornberry

ok, das würde dann erklären warum per default im BDS eingestellt ist das Tabs durch leerzeischen ersetzt werden.

Ich glaube die Verteufelung des Tabs lässt sich einfach auf das von mir geschilderte Verhalten vom Delphi Editor zurückführen.

btw: leerzeischen? :lol:

[MaBuSE]

Zitat:

Zitat von SirThornberry

Die Einrückung ist leider in den Editoroptionen beim BDS2006 nicht auf Tabs gestellt per Default. Und um nachträglich das zu ändern muss man mit dem Cursor durch jede Zeile wandern.

Du kannst auch alles markieren und mit [Ctrl+K][I] (indent) alles nach rechts einrücken und mit [Ctrl+K][U] (unindent) wieder zurückrücken.
Danach werden alle Tabs in der Quelltext Datei durch die Delphi IDE in 2 Leerzeichen umgewandelt.
(Alternativ könntest Du Dir auchen einen Experten schreiben, der über IOTASourceEditor die Einrückung (Umwandlung von Tab nach Space) vornimmt.)
Nachteil bei Versionsverwaltung. Beim Einchecken sind natürlich alle diese Zeilen als geändert sichtbar. (außer man sagt dem Diff, dass es keine Änderungen an den Whitespaces anzeigen soll)

Ich persönlich finde Leerzeichen besser. Das liegt auch daran, das ich oft auf Notepad zurückgreife um was nachzuschauen. In Notepad kann man keine Tab-Einstellungen vornehmen.
(Im Gegensatz zu UltraEdit und Delphi ist Notepad auf jeder Windows Maschine installiert ;-))

[SubData]

Ist das nich sogar schon seit ewigen Delphi Versionen so?
Also D7 macht auch Leerzeichen, wenn man mit TAB einrückt... :)

[Namenloser]

Ich meine, dass es diese Option sogar bei Delphi 3 gibt....

Abgesehen davon rücke ich immer mit Leerzeichen ein, weil ich mich da irgendwie dran gewöhnt habe, und ich persönlich schneller zweimal die Lehrtaste drücken kann, als einmal die Tabtaste.

Was die Einrückung an sich betrifft, halte ich mich ziemlich genau an die Borland-Vorgaben. (Manchmal variiere ich, um Sachen übersichtlicher oder kürzer zu machen. Beispiel:

Delphi-Quellcode:

blaaaaaaaaaa('hallo',
             'welt',
             'möp',
             'und',
             'tschüss');

statt

Delphi-Quellcode:

blaaaaaaaaaa('hallo','welt','möp','und','tschüss');

[Phoenix]

Zitat:

Zitat von Object Pascal Styleguide

"Object Pascal Styleguide"]4.3 Indentation

You should always indent two spaces for all indentation levels. In other words, the first level of indentation is two spaces, the second level four spaces, the third level 6 spaces, etc. Never use tab characters.

[/quote]

Dieser Styleguide ist bereits 10 Jahre alt und im speziellen dieser Absatz ist inzwischen obsolet. Wie gesagt: Es gibt objektiv betrachtet nur Nachteile für Leerzeichen und keine für Tabs. Zudem ist eine Einrückung um 2 Zeichen eh nachgewiesenermassen suboptimal, die optisch ideale Einrückungstiefe ist 3.

Siehe aber auch generell mal hier: http://www.derkarl.org/why_to_tabs.html

[SirThornberry]

@Mabuse: mit Suchen->Ersetzen ging es auch recht schnell.

[rwachtel]

Zitat:

Zitat von Phoenix

[...] Dieser Styleguide ist bereits 10 Jahre alt und im speziellen dieser Absatz ist inzwischen obsolet. Wie gesagt: Es gibt objektiv betrachtet nur Nachteile für Leerzeichen und keine für Tabs. Zudem ist eine Einrückung um 2 Zeichen eh nachgewiesenermassen suboptimal, die optisch ideale Einrückungstiefe ist 3. [...]

Objektiv betrachtet hat halt jedes Entwicklungsteam (zum Glück) eine subjektive Wahl. Suoboptimal ist nur, wenn jeder sein eigenes Süppchen kocht. Daher: besser ein alter Styleguide als gar keiner...

[Zacherl]

Ich rücke normal auch so ein:

Delphi-Quellcode:

procedure Button1.Click(Sender: TOBject); 
begin 
  If 1 > 0 then 
  begin 
    Application.Terminate; 
  end; 
  Label1.Caption := 'Mich gibt''s nicht!' 
end;

Florian

[Cöster]

Ich halte mich auch an den DSDT-Styleguide, also den von Borland.

Ich benutze auch KEIN Tab:

Grund:
Bei z.B. Delphi 5 Standard rückt Tab immer auf die Höhe des nächsten Wortes in der nächsthöheren Zeile ein. Wenn in der nächsthöheren Zeile kein Wort mehr folgt, dessen Anfangsbuchstabe sich rechts vom Cursor befindet, guckt er in der Zeile darüber usw. D.h. mal rückt Tab 1 Zeichen ein, mal 20.
In einigen Zeilen befindet man sich nach 5mal Tab weiter links als in anderen Zeilen, in denen man nur 3 mal Tab drückt.
Wenn in keiner der darüberliegenden Zeilen mehr ein Wort rechts vom Cursor beginnt, rückt Tab nicht mehr weiter ein.
Die Einrückungen werden dann auch sofort in Leerzeichen umgewandelt, d.h. es braucht auch nicht weniger Speicher, wenn man Tab drückt statt ein paar mal die Leertaste.

[OregonGhost]

Zitat:

Bei z.B. Delphi 5 Standard rückt Tab immer auf die Höhe des nächsten Wortes in der nächsthöheren Zeile ein.

Das ist die so genannte intelligente Einrückung. Hat nichts mit dem normalen Tab-Einrücken zu tun.

[Phoenix]

Zitat:

Zitat von Cöster

Grund:
Bei z.B. Delphi 5 Standard rückt Tab immer auf die Höhe des nächsten Wortes in der nächsthöheren Zeile ein. Wenn in der nächsthöheren Zeile kein Wort mehr folgt, dessen Anfangsbuchstabe sich rechts vom Cursor befindet, guckt er in der Zeile darüber usw. D.h. mal rückt Tab 1 Zeichen ein, mal 20.

Sorry, aber 'Ich kann meine IDE / meinen Editor nicht vernünftig konfigurieren / bedienen.' ist nun wirklich kein Grund dafür, gegen Tabs zu argumentieren. :wall:

[MaBuSE]

Zitat:

Zitat von Phoenix

Sorry, aber 'Ich kann meine IDE / meinen Editor nicht vernünftig konfigurieren / bedienen.' ist nun wirklich kein Grund dafür, gegen Tabs zu argumentieren. :wall:

Doch, das ist ein sehr guter Grund.

Ich kann es niemanden verübeln Leetzeichen zu verwenden, weil es der Standard (in Delphi) ist und er um Tabs zu verwenden in die Tiefen der IDE Konfiguration einsteigen müsste. ;-)

[MaBuSE]

Zitat:

Zitat von SirThornberry

@Mabuse: mit Suchen->Ersetzen ging es auch recht schnell.

Ah, ein [Ctrl+Q][A] Fan :mrgreen:

[arbu man]

Trotz des StyleGuids rüch ich so ein:

Delphi-Quellcode:

function  foo: integer;
begin
  if a > b then begin
    for i:= 0 to b do begin
      a:= 0;
    end;
  end;
end;

Find ich irgent übersichtlicher.

[Balu der Bär]

Meine Weg:

Delphi-Quellcode:

function foo: Integer;
begin
  if a > b then
   begin
    for i:= 0 to b do 
     begin
      a:= 0;
     end;
   end;
end;

Finde ich bedeutend übersichtlicher, ist aber eh alles Geschmackssache. ;)

[3_of_8]

Delphi-Quellcode:

function foo: Integer;
begin
  if a > b then
   begin
    for i:= 0 to b do
     begin
      a:= 0;
     end;
   end;
end;

Dito.

[Matze]

@Balu: Das Einrücken um 1 Zeichen habe ich jetzt noch nie gesehen, finde es auch etwas unübersichtlich, aber da gehen die Meinungen natürlich auseinander. ;)

Ich rückte bisher immer mit 2 Leerzeichen ein, habe jedoch einige Wochen ausschließlich mit PHP programmiert und dort immer mit Tabs (Tabweite: 4) eingerückt, da ich bei den geschweiften Klammern die Einrückung von 2 nicht schön fand. Auch kann ich, wenn sich mein Geschmack ändern sollte, jederzeit die Tabweite ändern. Tabweite 4 fand ich so hübsch, darum mach ich's in Delphi nun meist auch so, wobei ich gerade dazu tendiere, doch lieber Tabweite 3 zu nehmen. :mrgreen:

[inherited]

Zitat:

Zitat von SirThornberry

eigentlich keine von den vorgezeigten Varianten. Bei mir gehört ein begin-end immer in die gleiche Einrücktiefe wie der dazugehörige Kopf (worauf sich das begin-end bezieht). Wenn ein Begin-End vorbei ist kommt bei mir die nächste Anweisung auf die gleiche Höhe wie der begin-end block. Also genau wie bei einer Baumstruktur (nur das man im Baum kein Begin-End sieht).
Also alles was innerhalb eines anderen Zweiges (begin-end) liegt wird eingerückt. Und das nächste Sibbling (Folgenanweisung) hat die gleiche Einrückung wie der vorhergehende Befehl/Befehlsblock.

*michbaluanschließ* so mach ich esauch.

[3_of_8]

Hopsala, hab ich ganz übersehen. Grundsätzlich rücke ich so ein wie Balu, nur immer mit 2 Leerzeichen.

[Khabarakh]

Erst wurde erwähnt, dass eine Einrückung um drei Leerzeichen (bzw. Darstellung der Tabs als solche) ideal wäre und nun kommt ihr alle mit einem Space :gruebel: ? Nun gut, über Geschmack lässt sich bekanntlich streiten, aber das finde ich ebnso wie Matze doch etwas unübersichtlich.
Ich halte es auch für sehr merkwürdig, wenn ein einzelnes Statement anders eingerückt wird wie die Anweisungen in einem Code-Block.