Mein Delphi-Style

[R2009]

Hi,
jetzt auch noch mein Senf dazu:

Das ist doch ein gutes Beispiel für ich sag mal Spaghetticode. Völlig unlesbar und das im Wesentlichen durch die dämliche Anordnung der begin und ends.

Delphi-Quellcode:

if k=kMax then A[k]:= A[k-1]/A[k] 
  if a=0 then Result:= 0 else if a>0 then Result:= 1 else Result:= -1; 
  if Sender=mnPrintGraphOben then h:= ro             // 'Drucken|Graph oben' 
                             else h:= rm;            // 'Drucken|Graph unten'                        
  for k:= 0 to kMax do A[k]:= 0; 
  for i:= 1 to iMax do begin temp:= A[i]; A[i]:= B[i]; B[i]:= temp end; 
  for i:= 2 to m do begin 
    for k:= 1 to i-1 do B[i]:= B[i] - A[r(i,k)]*B[k]; 
    B[i]:= B[i]/Abs(A[r(i,i)]) end; 
  with Image1.Canvas do begin 
    MoveTo(DL, D0 - Round(sy*(F(xMin)-yMin))); 
    for i:= 0 to 320 do begin 
      x:= xMin + i*dx; 
      LineTo(DL + 2*i, D0 - Round(sy*(F(x)-yMin))) end end;

was für ein Unterschied:

Delphi-Quellcode:

  //Kommentar
  if k=kMax then A[k]:= A[k-1]/A[k]; 
  
  //Kommentar
  if a=0 then Result:= 0 else if a>0 then Result:= 1 else Result:= -1; 
  
  //Kommentar
  if Sender=mnPrintGraphOben then h:= ro             // 'Drucken|Graph oben' 
                             else h:= rm;            // 'Drucken|Graph unten'                        
  //Kommentar
  for k:= 0 to kMax do A[k]:= 0;

  //Kommentar 
  for i:= 1 to iMax do 
    begin 
      temp:= A[i]; A[i]:= B[i]; B[i]:= temp;
    end; 

  //Kommentar
  for i:= 2 to m do 
    begin 
      for k:= 1 to i-1 do B[i]:= B[i] - A[r(i,k)]*B[k]; 
      B[i]:= B[i]/Abs(A[r(i,i)]) 
    end;
  
  //Kommentar 
  with Image1.Canvas do 
    begin 
      MoveTo(DL, D0 - Round(sy*(F(xMin)-yMin))); 
      for i:= 0 to 320 do 
        begin 
          x:= xMin + i*dx; 
          LineTo(DL + 2*i, D0 - Round(sy*(F(x)-yMin))) 
        end
    end;

Das ist Pascal-Style wie er leibt und lebt und nicht dieser einge"C"te Kodemischmasch.
Mich kriegt ihr von diesem Stil nicht weg und gerade das macht den Kode übersichtlich und lesbar.

Nebenbeibemerkt find ich
void irgendwas()
{
}
auch besser als
Nebenbeibemerkt find ich
void irgendwas(){
}


Viele Grüsse

[Luckie]

Zitat von himitsu:

solange es eh klar ist, daß die Einzelteile eh nie wo anders mal Wiederverwendung finden könnte, dann mach ich mir lieber nur 'ne Leerzeile rein

Es geht nicht in erster Linie um Wiederverwendung, sondern um Übersichtlichkeit, Wartbarkeit usw.

@R2009: Benenn die Variablen sinnvoll und unterteile den Code und die Kommentare werden überflüssig.

[himitsu]

Zitat von Luckie:

Es geht nicht in erster Linie um Wiederverwendung, sondern um Übersichtlichkeit, Wartbarkeit usw.

Wenn es aber ein logisch zusammenhängender Strang ist, dann find ich es übersichtlicher, wenn er auch mehr zusammenhängt.

Und man stelle sich mal vor, ich hätte beim himXML z.B. bei der Serialisierung wirklich jeden Typ einzeln in eine Funktion verpackt, das wären bestimmt nochmal 40-50 Funktionen mehr, was ich dann nicht wirklich übersichtlicher empfinden würde.

Oder mein CheckChar dort ist das eine "größere" Funktion mit verschachteltem CASE und einem Parameter was geprüft werden soll ... ich hab inzwischen bei ein/zwei anderen XMLLibs sowas Ähnliches gesehn, allerdings mit mehreren Funktionen, dagegen kommt mir meine Variante mit dem Parameter (Set) einfacher vor ... ließ sich bisher auch leichter etwas nachrüsten und Doppeltes erkennen.

[Mithrandir]

Ich denke, das ist in vielen Fällen einfach geschmackssache. Ich würde es so vorschlagen:

• Jeder, der closed-source Anwendungen schreibt, der soll seinen Code so schreiben, dass er ihn am Besten warten kann.
• Jeder, der open-source Anwendungen schreibt, und sie ohne Erwartungen der Community zur Verfügung stellt, soll seinen Code so schreiben, dass er ihn am Besten warten kann.
• Jeder, der eine Anwendung schreibt, und zur Fehlerfindung oder allgemeinen Feedback den Quelltext veröffentlicht, sollte sich an die allgemein gültigen Style-Guides halten.

[R2009]

Hi Daniel G,

Zitat:

Jeder, der closed-source Anwendungen schreibt, der soll seinen Code so schreiben, dass er ihn am Besten warten kann.

Jeder, der open-source Anwendungen schreibt, und sie ohne Erwartungen der Community zur Verfügung stellt, soll seinen Code so schreiben, dass er ihn am Besten warten kann.

Jeder, der eine Anwendung schreibt, und zur Fehlerfindung oder allgemeinen Feedback den Quelltext veröffentlicht, sollte sich an die allgemein gültigen Style-Guides halten.

Kann ich so voll unterschreiben. Wenn du mir jetzt noch sagst wo die "allgemein gültigen Style-Guides" liegen und wer sie festlegt brech ich in lautes jubeln aus!

Viele Grüsse!

[Mithrandir]

Zitat von R2009:

Kann ich so voll unterschreiben. Wenn du mir jetzt noch sagst wo die "allgemein gültigen Style-Guides" liegen und wer sie festlegt brech ich in lautes jubeln aus!

Naja, der Plural war vielleicht übertrieben, aber bei EMBT liegt ein schöner Artikel.

[R2009]

Hi Daniel G,

der Styleguide gefällt mir. Das was ich gesehen hab ist ganz nach meinen Geschmack.
Vor allem wurde das Ding scheinbar von einem "nicht C verseuchten" Kollegen geschrieben.
Damit das hier zur Bibel wird hab ichs als PDF angehängt!

Viele Grüsse!

[generic]

Zitat von Daniel G:

Naja, der Plural war vielleicht übertrieben, aber bei EMBC liegt ein schöner Artikel. ;)

Zitat von R2009:

Hi Daniel G,
Damit das hier zur Bibel wird hab ichs als PDF angehängt!

Beitrag #11 übersehen?

[Mithrandir]

Nein, gekonnt ignoriert.

Quark, tatsächlich überlesen...

[jbg]

Zitat von Daniel G:

aber bei EMBC

OT: EMBC kürzt sich mit EMBT (T wie Technologies) ab