Function, Result als stringlist?

[choose]

Zitat von Luckie:

procedure Foo(s: String; c: Char; var sl: TStringList);

Hallo Luckie, hallo silent,

bei diesem Aufruf könnte der unbedachte Entwickler von Foo, der lediglich die Schnittstelle bekommt, folgendes Schreiben:

Delphi-Quellcode:

procedure Foo(s: string; c: Char; var sl: TStringList);
begin
  sl:= TStringList.Create;
  //...
end;

Schließlich geht er davon aus, dass in sl ein Ergebnis zu stehen hat. In diesem Fall (da CallByReference) würde alles "fehlerfrei" funktionieren, allerdings die ürsprüngliche Referenz (erzeugt beim Klienten) verloren sein!

Es bietet sich an, die Schlüsselworte const und out zu verwenden, um deutlich zu machen, ob eine Variable oder ein Exemplar unverändert bleibt (auch wenn das nicht von Delphi überprüft wird) oder ob ein Parameter lediglich als Ergebnis dient und, im Falle eines Objekts, innerhalb der Routine erzeugt werden soll.
Der verbleibende Fall, weder const nocht out, bedeutet dann konstequenterweise, dass ein (wahrscheinlich) initialisiertes Objekt übergeben und verändert werden kann, jedoch nicht innerhalb der Routine erzeugt wird...

Delphi-Quellcode:

//:Creates and fills a new object
procedure CreateNewInstance(out AnInstance: TMyClass);
//:Uses an object but doesnt modify it
procedure ReadFromInstance(const AnInstance: TMyClass);
//:Uses and may modify an object
procedure ReadFromAndWriteToInstance(AnInstance: TMyClass);

Diese Konvention hat sich in der Praxis gut bewährt und reichte zusammen mit sprechenden Bezeichnungen oft als Schnittstellenbezeichnungen für einfache Routinen aus

Zitat von Tom:

Wofür mußt Du einen Zeiger auf NIL setzen, wenn dieser garantiert nicht mehr gebraucht wird (z.B. Verwendung von lokalen Variablen)?

@TOM: Auch wenn man selbst eine Variable nicht länger braucht, kann ein anderer das nicht ahnen... Hat er die Aufgabe, Deinen Code zu erweitern und findet er die passende Variable, könnte es sein, dass er die Freigabe übersehen hat. Ein neue eingeführter Code der Art

Delphi-Quellcode:

//signature and intent of new code
Assert(Assigned(sl));
if sl.Count>0 then
  FooBar(sl[0]);

würde ihn sofort auf seinen Fehler aufmerksam machen.