Zweck des Schreibens
Diese Spezifikation definiert die Programmdateien und den Codierungsstil, die am Schreibprozess des Programms beteiligt sind. Diese Spezifikation wurde auf Basis der Delphi-Sprache entwickelt.
Organisation von Projektdokumenten
In Delphi sind Programmdateien nach Projekteinheiten organisiert. Zu einem typischen Projekt gehören:
Projektdateien (.DRP-Dateien)
Enthält den Pascal-Quellcode des Hauptprogramms des Projekts;
Unit-Dateien (.PAS-Dateien)
Pascal-Quelldatei für jedes Formular im Projekt, einschließlich aller Deklarationen und Prozeduren des Formulars (einschließlich Zeitverarbeitungsverfahren);
Formulardateien (.DFM-Dateien)
Eine Binärdatei, die die Designeigenschaften eines Formulars enthält. Die .DFM-Datei und die .PAS-Datei jedes Formulars entsprechen einander.
Ressourcendatei (.RES-Datei)
Kompilierte binäre Ressourcendateien, die mit der ausführbaren Datei der Anwendung verknüpft sind;
Projektoptionsdatei (.DOF-Datei)
Speichert die Projektoptionen, die mit dem Menübefehl „PProjekt|Optionen“ festgelegt wurden.
Desktop-Einstellungsdatei (.DSK-Datei)
Speichert die Desktop-Optionen, die über den Menübefehl Extras|Optionen festgelegt wurden.
Paketdatei (.DPK/.BPL-Datei)
Dateien, die zum Teilen von Komponenten, Klassen, Daten und Code verwendet werden. Die Quelldatei ist eine .DPK-Datei und nach der Kompilierung eine .BPL-Datei;
konstante Definition
Inhalt:
Definition logischer Werte;
Definition eines konstanten Wertes;
Definition des Fehlercodes;
Format: Eine Definition pro Zeile. wie folgt:
Const<Konstante>: type = value; //Kommentar
veranschaulichen:
Verwenden Sie die Const-Anweisung, um Konstanten zu deklarieren, die anstelle von Literalwerten verwendet werden.
Beispiel: Const C_SQL:string='select CH_USERER_ID from T_CD_USER'; //Benutzer-ID abfragen
Const C_PI:real =3.1415926; //Pi
Definition des Strukturtyps
Inhalt: Strukturtypdefinition
Format:
Typ
<Typname>//Strukturbeschreibungskommentare
<Variablenname 1>: Variablentyp; //Variablenbeschreibungskommentare
<Variablenname 2>: Variablentyp; //Variablenbeschreibungskommentare
…
Ende;
veranschaulichen:
<Typname> ist eine Zeichenfolge, die mit einem Großbuchstaben beginnt. Die Anweisungen zur Definition von Variablentypen in der Strukturdefinition beginnen in der zweiten Zeile und fünften Spalte.
Beispiel:
Typ
TableList=record //Definition des Typs der Systembaumeinheit
InID: Ganzzahl; //Einheitsnummer
Name: string; //Einheitenname
PID: string; //Vorheriger Einheitenname
PT: PTableList; //Zeiger auf den nächsten Einheitentyp
Ende;
Programmierstil
Der Programmierstil legt die Positionierungsregeln für jede Anweisung und die Kommentare im Programm fest.
Funktions-/Ablaufstil
<Funktion/Prozedur> Name (Variable: Variablentyp [,...]);//Funktions-/Prozedurbeschreibung
var
Variable 1: Variablentyp; // Variablenbeschreibung
Variable 2: Variablentyp; //Variablenbeschreibung
…
beginnen
Stellungnahme;
Stellungnahme;
…
Ende ;
Hinweis: Variablendeklarationen und -anweisungen werden ab der dritten Spalte geschrieben. Wenn eine Einrückung vorhanden ist, rücken Sie sie jeweils um zwei Spalten ein und richten Sie sie an den entsprechenden Anweisungen aus.
Statement-Stil
veranschaulichen:
Für höchstens zehn Zeilen im Programmhauptteil gibt es normalerweise eine Funktionsbeschreibung in einem Absatz;
Standardisieren Sie die Verwendung verschiedener Anweisungen.
Die Einrückung in Anweisungen erfolgt in Einheiten von zwei Spalten.
Variablendefinitionsanweisung
var
var_name: <Datentyp>;
Zuweisungserklärung
var_name: = <Ausdruck>;
bedingte Anweisung
Wenn Bedingung, dann //Kommentar
beginnen
Stellungnahme;
…
Ende
sonst wenn Bedingung dann//Kommentar
beginnen
Stellungnahme;
...
Ende
sonst//Kommentar
Stellungnahme;
Hinweis: Wenn nur eine Ausführungsanweisung vorhanden ist, können die Anweisungen begin und end weggelassen werden.
Schleifenanweisung
//Schleifenfunktionsanmerkung
for counter := start to end do
beginnen
[Stellungnahme];
…
Ende;
//Schleifenfunktionsanmerkung
während [Bedingung] dies tut
beginnen
[Stellungnahme];
…
Ende;
//Schleifenfunktionsanmerkung
wiederholen
[Stellungnahme];
…
bis [Bedingung]
switch-Anweisung
//Funktionsbeschreibung wechseln
Fall <Ausdruck> von
<Wert1>:[Anweisung 1];
<Wert2>:[Anweisung 2];
…
<Wert>: [Anweisung n]
Ende;
Kommentarzeile
Für diese Unit-Datei müssen am Anfang der Programmcode-Unit-Datei die Kommentare „Module Description“ und „Unit Description“ stehen.
Für sinnvolle Codeteile wie Konstanten, Strukturtypen, Funktionen/Prozeduren, benutzerdefinierte Variablen, Codesegment-Funktionsblöcke, Schlüsselanweisungen usw.
Punkte müssen in einer Kommentarzeile ausführlich erläutert werden.
Die Kommentarzeile kann mit „//XXXXXXXX“ nach der zu erläuternden Zeile oder auch oberhalb der zu erläuternden Zeile eingefügt werden.
Fügen Sie mehrere Zeilen mit „{XXXXXXXX}“ hinzu oder fügen Sie eine einzelne Zeile mit „//XXXXXXXX“ hinzu.
Benennung von Dateien und Formularen
Bedeutung des Namensformats für Klassennamen
Projektdatei Programm (.DPR) XXXXX
UnitUnit(PAS) uXXXXX
FormForm.Name(.DFM) XXXXXFrm
DatenmodulDataModule XXXXXDM
Einheitenkopfdefinition, vor jeder Einheit hinzugefügt.
{************************************************ * ***
Einheitenname:
Funktionsbeschreibung:
Autor:
Softwarename:
Version:
Firmenname: Sword as Dream Software Creation Studio
************************************************** * *** }
Definition des Softwareversionsnummernformats:
Die Software verwendet das folgende Versionsnummernformat: XXXX
Beispiel: Nachdem das veröffentlichbare Programm abgeschlossen ist, wird die Versionsnummer als „1.0.0.0“ markiert.
Die erste Ziffer: Versionsnummer. Hinweis: Dies ist eine Version der Software, die erheblich verbessert wurde.
Zweite Ziffer: Wartungsnummer. Hinweis: Einige Fehler wurden basierend auf der vorhandenen Version geändert.
Die dritte Ziffer: Patch-Nummer. Hinweis: Wenn das Programm einige Fehler behebt und keine neue Wartungsnummer gebildet wird, wird die Patch-Nummer verwendet.
Die vierte Ziffer: Korrekturnummer. Hinweis: Wenn ein Notfallprogrammfehler auftritt, wird das geänderte Programm als Kennung und nicht als Versionsnummer des freigegebenen Programms verwendet. yckxzjj