TSeries + DataEndpoint
This commit is contained in:
Michael Schimmel
@@ -2,7 +2,7 @@
|
||||
|
||||
* Unterstütze mich bei der Entwicklung unter Embarcadero Delphi.
|
||||
* Ich bin ein sehr erfahrener Softwareentwickler. Fasse dich kurz und nutze Fachsprache.
|
||||
* Wir nutzen immer die neueste Delphi-Version, aktuell ist das Delphi 12 Athens.
|
||||
* Wir nutzen immer die neueste Delphi-Version, aktuell ist das Delphi 12.3 Athens.
|
||||
|
||||
|
||||
|
||||
@@ -46,7 +46,8 @@
|
||||
- Einrückung mit 4 Leerzeichen anstelle von 2. Auch bei Kommentaren.
|
||||
- Das Code-Format ist UTF-8. Nur ASCII, keine Sonderzeichen erlaubt (insb. kein No-Break-Space!)
|
||||
- Folgende Schlüsselwörter müssen klein geschrieben werden:
|
||||
and, or, not, mod, div, in, as, is, array of, sizeof(), inc(), dec()
|
||||
and, or, not, mod, div, in, as, is, array of, sizeof(), inc(), dec(), exit, inc, dec, shl, shr
|
||||
- Compiler-Direktiven (z.B. $region) sollen immer klein geschrieben werden.
|
||||
|
||||
* Ändere niemals vorhandene Bezeichner im vom Benutzer bereitgestellten Code, es sei denn du wirst dazu aufgefordert.
|
||||
|
||||
@@ -63,9 +64,9 @@
|
||||
|
||||
* Achte beim Erstellen von Format-Strings (z. B. mit Format()), darauf, dass die Anzahl der Parameter genau der Anzahl der Format-Tags (z. B. %s, %d) entspricht. Überprüfe die Typkompatibilität.
|
||||
|
||||
* Denke daran, dass Delphi nicht zwischen Groß- und Kleinschreibung unterscheidet. Bezeichner müssen sich von Schlüsselwörtern unterscheiden.
|
||||
* Denke daran, dass Delphi nicht zwischen Groß- und Kleinschreibung unterscheidet. Bezeichner müssen sich immer von Schlüsselwörtern unterscheiden.
|
||||
|
||||
* Interfaces benötigen keine GUIDs. Füge keine GUIDs in Interfaces ein und schlagen Sie dies auch nicht vor. Wenn ein gegebenes Interface keine GUID hat, ist das so gewollt. GUIDs werden ausschließlich von mir vergeben. Wenn du der Meinung bist, dass ein Interface unbedingt eine GUID benötigt, dann weise mich darauf hin.
|
||||
* Interfaces benötigen keine GUIDs. Füge keine GUIDs in Interfaces ein und schlagen Sie dies auch nicht vor. Wenn ein gegebenes Interface keine GUID hat, ist das so gewollt. GUIDs werden ausschließlich von mir vergeben. Füge niemals selbst eine GUID hinzu.
|
||||
|
||||
* TThread ist in System.Classes definiert.
|
||||
* TInterlocked ist in System.SyncObjs definiert.
|
||||
@@ -74,24 +75,40 @@
|
||||
* begin und end stehen am Anfang einer neuen Zeile. then steht nie am Anfang einer neuen Zeile.
|
||||
* RECORDs, die einen Initialize-Operator haben, sind Managed Records. Sie benötigen also kein explizites Create.
|
||||
|
||||
# Unit-Tests
|
||||
# In Unit-Tests
|
||||
|
||||
* Verwende nur statische Strings für Log-Einträge und Asserts. Keine Format(), ToString usw. (Das verursacht Speicherlecks außerhalb des Test-Gültigkeitsbereichs, sodass ein Leak vom Memory Manager gemeldet wird.)
|
||||
|
||||
* Verwende das Attribut für parametrische Tests, z. B. [TestCase('TestName', 'Parameter1,Parameter2,...')]
|
||||
* Verwende das Attribut für parametrische Tests, um verschiedene Szenarien durchzuspielen. Z. B. [TestCase('TestName', 'Parameter1,Parameter2,...')]
|
||||
|
||||
|
||||
# Kommentare im Code
|
||||
|
||||
* Vermeide jegliche Kommentare, die Änderungen am Code beschreiben. Z.B. `// hier wurde was geändert`. Das mag ich gar nicht.
|
||||
|
||||
* Kommentare sind immer englisch.
|
||||
|
||||
* Benutze keine HTML-Tags (`<summary>`, etc.)!
|
||||
* Benutze `//` oder `(* *)` und fasse dich extrem kurz. Meistens genügen Einzeiler vor den Deklarationen.
|
||||
|
||||
* Kommentare in der interface-Sektion einer Unit sollen die Schnittstelle dokumentieren. Dokumentiere ausschließlich Elemente, die auch von außen zugänglich sind. Und beziehe dich nur auf Elemente, die von außen zugänglich sind. Im Interface wird beschrieben, WAS eine Funktion macht. Es wird nicht beschrieben WIE sie es macht!
|
||||
* Kommentare in der interface-Sektion einer Unit sollen die Schnittstelle dokumentieren. Dokumentiere ausschließlich Elemente, die auch von außen zugänglich sind, und beziehe dich auch nur auf Elemente, die von außen zugänglich sind. Im Interface wird beschrieben, **was** eine Funktion macht. Es wird nicht beschrieben **wie** sie es macht!
|
||||
|
||||
* Kommentare im Implementation-Teil sollten sehr sparsam eingesetzt werden. Sie sind nur nötig, wenn etwas wirklich kompliziertes Beschrieben werden muss und auch nur, wenn sich die Funktion nicht aus dem Quelltext ergibt.
|
||||
|
||||
* Jede Klassen-, Record-, oder Interface-Definition sollte einen sinnvollen Einzeiler haben.
|
||||
|
||||
# Refactoring
|
||||
|
||||
* Umschließe alle Reader- und Writer-Properties innerhalb einer Interface-Definition mit eine Region 'private'. So zum Beispiel:
|
||||
|
||||
```
|
||||
IConverter = interface(IMycProcessor<S>)
|
||||
{$region 'private'}
|
||||
function GetSender: TDataProvider<T>.IDataProvider;
|
||||
{$endregion}
|
||||
property Sender: TDataProvider<T>.IDataProvider read GetSender;
|
||||
end;
|
||||
```
|
||||
|
||||
# Projektplan
|
||||
|
||||
@@ -109,6 +126,8 @@
|
||||
**Interface helper** sind ein Konzept, dass *nicht* explizit in Delphi/Pascal verankert ist. Es werden stattdessen managed records benutzt um ein Interface zu kapseln und die zugrundeliegende Implementierung vollständig zu verbergen.
|
||||
|
||||
- Ein "interface helper" ist ein managed record, das immer nur **genau ein** Interface referenziert.
|
||||
|
||||
- Die Definition des Interface findet sich meist im Scope des helpers (ganz am Anfang mit Default-Visibility).
|
||||
|
||||
- Es verbirgt die verschiedenen Implementierungen des Interface und fungiert als generische "Instanz" des interface.
|
||||
|
||||
@@ -122,79 +141,79 @@
|
||||
- Wrapper für die Methoden und Properties des Interface.
|
||||
- ein class property "Null".
|
||||
|
||||
* Immer wenn ein interface helper für ein interface vorhanden wird, soll er auch benutzt werden. Greife nicht direkt auf die Implementierung zu, lasse den helper das erledigen.
|
||||
* Direkte Wrapper auf Interface-Methoden sind *inline*.
|
||||
|
||||
## Beispiel:
|
||||
* Immer wenn ein interface helper für ein interface vorhanden wird, soll er auch benutzt werden. Greife nicht direkt auf die Implementierung zu, lasse den helper das erledigen. Beispiel:
|
||||
|
||||
```
|
||||
type
|
||||
IFuture = interface
|
||||
function GetValue: T;
|
||||
function GetDone: TState;
|
||||
end;
|
||||
```
|
||||
type
|
||||
TFuture<T> = record
|
||||
type
|
||||
IFuture = interface
|
||||
function GetValue: T;
|
||||
function GetDone: TState;
|
||||
end;
|
||||
|
||||
TFuture<T> = record
|
||||
{$REGION 'private'}
|
||||
strict private
|
||||
class var
|
||||
FNull: IFuture;
|
||||
strict private
|
||||
class var
|
||||
FNull: IFuture;
|
||||
|
||||
class constructor CreateClass;
|
||||
class constructor CreateClass;
|
||||
|
||||
private
|
||||
FFuture: IFuture;
|
||||
function GetDone: TState; inline;
|
||||
function GetValue: T; inline;
|
||||
{$ENDREGION}
|
||||
public
|
||||
constructor Create(const AFuture: IFuture);
|
||||
private
|
||||
FFuture: IFuture;
|
||||
function GetDone: TState; inline;
|
||||
function GetValue: T; inline;
|
||||
|
||||
class operator Initialize(out Dest: TFuture<T>);
|
||||
class operator Implicit(const A: IFuture): TFuture<T>; overload;
|
||||
class operator Implicit(const A: TFuture<T>): IFuture; overload;
|
||||
public
|
||||
constructor Create(const AFuture: IFuture);
|
||||
|
||||
class property Null: IFuture read FNull;
|
||||
class operator Initialize(out Dest: TFuture<T>);
|
||||
class operator Implicit(const A: IFuture): TFuture<T>; overload;
|
||||
class operator Implicit(const A: TFuture<T>): IFuture; overload;
|
||||
|
||||
// Wrapper methods for IFuture
|
||||
property Done: TState read GetDone;
|
||||
property Value: T read GetValue;
|
||||
end;
|
||||
class property Null: IFuture read FNull;
|
||||
|
||||
constructor TFuture<T>.Create(const AFuture: IFuture);
|
||||
begin
|
||||
FFuture := AFuture;
|
||||
if not Assigned(FFuture) then
|
||||
FFuture := FNull;
|
||||
end;
|
||||
// Wrapper methods for IFuture
|
||||
property Done: TState read GetDone;
|
||||
property Value: T read GetValue;
|
||||
end;
|
||||
|
||||
class constructor TFuture<T>.CreateClass;
|
||||
begin
|
||||
// init FNull
|
||||
end;
|
||||
constructor TFuture<T>.Create(const AFuture: IFuture);
|
||||
begin
|
||||
FFuture := AFuture;
|
||||
if not Assigned(FFuture) then
|
||||
FFuture := FNull;
|
||||
end;
|
||||
|
||||
class operator TFuture<T>.Implicit(const A: IFuture): TFuture<T>;
|
||||
begin
|
||||
Result.Create(A);
|
||||
end;
|
||||
class constructor TFuture<T>.CreateClass;
|
||||
begin
|
||||
FNull := TNullFuture.Create;
|
||||
end;
|
||||
|
||||
class operator TFuture<T>.Implicit(const A: TFuture<T>): IFuture;
|
||||
begin
|
||||
Result := A.FFuture;
|
||||
end;
|
||||
class operator TFuture<T>.Implicit(const A: IFuture): TFuture<T>;
|
||||
begin
|
||||
Result.FFuture := A;
|
||||
end;
|
||||
|
||||
class operator TFuture<T>.Initialize(out Dest: TFuture<T>);
|
||||
begin
|
||||
Dest.FFuture := FNull;
|
||||
end;
|
||||
class operator TFuture<T>.Implicit(const A: TFuture<T>): IFuture;
|
||||
begin
|
||||
Result := A.FFuture;
|
||||
end;
|
||||
|
||||
function TFuture<T>.GetDone: TState;
|
||||
begin
|
||||
Result := FFuture.Done;
|
||||
end;
|
||||
class operator TFuture<T>.Initialize(out Dest: TFuture<T>);
|
||||
begin
|
||||
Dest.FFuture := FNull;
|
||||
end;
|
||||
|
||||
function TFuture<T>.GetValue: T;
|
||||
begin
|
||||
Result := FFuture.Value;
|
||||
end;
|
||||
```
|
||||
function TFuture<T>.GetDone: TState;
|
||||
begin
|
||||
Result := FFuture.Done;
|
||||
end;
|
||||
|
||||
function TFuture<T>.GetValue: T;
|
||||
begin
|
||||
Result := FFuture.Value;
|
||||
end;
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user