Die "richtige" Sourcecode Formatierung?

[Stevie]

Zitat von p80286:

Dann gehörst du aber zu sehr glücklichen Menschen, die gleich bei der ersten Eingabe direkt wissen, was der treffende Name ist. Ich brache immer 2 ode drei Überarbeitungen, bis alles so ist, daß ich auch in einem Jahr noch verstehe wie der Code funktioniert.

Nö, bestimmt nicht, ich verbringe einen großen Teil meiner Zeit damit, meinen eigenen (gestern natürlich noch von mir selbst fälschlicherweise als perfekt bewerteten ) oder fremden Code zu refactorn

[Neutral General]

Zitat von p80286:

Das mit den Units, mache ich genauso wie Mavarik, wobei man bei der ersten Unit natürlich gekniffen ist.

Wenns bei einer Unit eh nicht funktioniert, dann kann man in meinen Augen auch so machen wie Stevie.
Das sieht visuell zumindest ordentlicher aus in meinen Augen. So ein Komma als Anfang der Zeile vor einem Wort sieht komisch aus.

[p80286]

Zitat von Neutral General:

Wenns bei einer Unit eh nicht funktioniert, dann kann man in meinen Augen auch so machen wie Stevie.
Das sieht visuell zumindest ordentlicher aus in meinen Augen. So ein Komma als Anfang der Zeile vor einem Wort sieht komisch aus.

Ungewohnt, aber ich mach es bei selects genauso, und da ist es meiner Meinung nach sehr hilfreich um fehlende Kommata zu finden

SQL-Code:

select feld1
      ,feld2
      ,feld3 as Umsatz
      ,feld5 as Rabatt
from tabelle1.....

und nach der Syntax gehört das Komma zur zweiten Unit.

Gruß
K-H

[madas]

Zitat von jaenicke:

Für mich sind bei der Formatierung wichtig:

• Zwingend per Codeformatter machbar (nur manuell formatieren können ist Blödsinn, das dauert viel zu lange, wenn ich fremden Quelltext einpflegen muss usw.)
• Weite Verbreitung der Formatierung, keine Sonderlocken
• Natürliches Schreiben: keine tausend unnötige Leerzeichen oder ähnliches
• Ein Befehl pro Zeile (damit man nicht erst die ganze Zeile durchlesen muss um weiterzulesen)
• Pro logischer Ebene eine Einrückung um zwei Zeichen nach rechts
• Kein Plenken

Das macht die Standardformatierung bereits, deshalb gibt es für mich keinen Grund eine andere zu benutzen. Zumal dies die häufigste Formatierung ist, wenn man so Open Source usw. anschaut. Alles andere ist eher selten bis exotisch zu finden.

Wegen des begin in einer Zeile:
Ich empfinde es als unsauber, wenn mehrere Befehle in eine Zeile gequetscht werden. Da läuft man nur in Gefahr etwas zu überlesen.

Sehe ich auch so.

Delphi-Quellcode:

if (Bedingung) then
  Anweisung;

if (Bedingung) then
begin
  Anweisung;
end;

if (Bedingung) then
begin
  Anweisung1;
end else
begin
  Anweisung2;
end;

if (Bedingung1) then
begin
  Anweisung1;
end else
if (Bedingung2) then
begin
  Anweisung2;
end;

Delphi-Quellcode:

procedure NamenSindGanzWichtig;
begin
  Anweisung;
end;

procedure NamenSindGanzWichtig;
var
  blaBla: String;
begin
  Anweisung;
end;

usw. usw.

[bernau]

Mal ne andere Sache.

Seit in Delphi vermehrt Unit-Scopenames verwendet werden, wird die Units-Deklaration immer größer.

Früher sah es so aus:

Delphi-Quellcode:

uses
  Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,
  StdCtrls, Dateedit, Buttons, ExtCtrls;

Jetzt sieht es so aus:

Delphi-Quellcode:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, Vcl.Graphics, Vcl.Forms, Vcl.Dialogs,
  Vcl.StdCtrls, Vcl.Controls, Vcl.Buttons, Vcl.ExtCtrls, System.Classes,

Vorher schon unübersichtlich. Jetzt ganz unübersichtlich.

Stelle jetzt meine Units auf folgende Schreibweise um.

Delphi-Quellcode:

uses
  Winapi.Windows, 
  Winapi.Messages, 
  System.SysUtils, 
  System.Classes,
  Vcl.Graphics, 
  Vcl.Forms, 
  Vcl.Dialogs,
  Vcl.StdCtrls, 
  Vcl.Controls, 
  Vcl.Buttons, 
  Vcl.ExtCtrls;

Sinnvoll oder nicht?

Wie handhabt Ihr das?

[uligerhardt]

Zitat von bernau:

Stelle jetzt meine Units auf folgende Schreibweise um.

Delphi-Quellcode:

uses
  Winapi.Windows, 
  Winapi.Messages, 
  System.SysUtils, 
  System.Classes,
  Vcl.Graphics, 
  Vcl.Forms, 
  Vcl.Dialogs,
  Vcl.StdCtrls, 
  Vcl.Controls, 
  Vcl.Buttons, 
  Vcl.ExtCtrls;

Sinnvoll oder nicht?

Wie handhabt Ihr das?

Hab ich schon immer so gemacht.

[Stevie]

Bei Forms und allem, wo mir die IDE Units reinkleistert, lass ich es so, in reinen Sourcecode Units untereinander.

[Benedikt Magnus]

Ich sortiere sie ein wenig, um es übersichtlicher zu gestalten:

Delphi-Quellcode:

uses
  { Standard }
    System.SysUtils, System.Types, System.UITypes, System.Classes, System.Variants,
    FMX.Types, FMX.Graphics, FMX.Controls, FMX.Forms, FMX.Dialogs, FMX.StdCtrls,
  { Indy }
    IdIOHandler, IdIOHandlerSocket, IdBaseComponent, IdComponent,
    IdTCPConnection, IdTCPClient, IdHTTP,
    IdCookieManager
  { Indy SSL }
    IdIOHandlerStack, IdSSL, IdSSLOpenSSL,
  { Eigen }
    Unit_HTTP, Unit_HTTPS, Unit_Modulverarbeitung
  {};

Edit: Wie die Sortierung/Gruppierung letztlich aussieht, hängt immer vom Projekt ab. Häufig teile ich Standard noch in System/GUI/Sonstiges oder Eigen ab einer gewissen Unitzahl in Spezifischeres auf.

[mjustin]

Woher kommt eigentlich dieses lästige und überflüssige A am Anfang von Parametern (z.B. "AValue")?

Im Delphi Style Guide ( http://edn.embarcadero.com/article/10280) ist es nicht zu finden.

Im Delphi Sourcecode - z.B. http://docwiki.embarcadero.com/Libra...ysUtils.Format - wird es nicht verwendet.

Handelt es sich um eine Modeerscheinung?

[Stevie]

Im Delphi Source findet man das durchweg an vielen Stellen - wird aber nicht konsequent durchgezogen, aber schau mal in Classes.pas z.B.
Da Delphi nunmal nicht case sensitiv ist, bietet es sich an, Parameter zu prefixen, damit es keine potenziellen Namenskollisionen gibt.