But de l'écriture
Cette spécification définit les fichiers de programme et le style de codage impliqués dans le processus d'écriture du programme. Cette spécification est développée sur la base du langage Delphi.
Organisation des documents de projet
Dans Delphi, les fichiers programme sont organisés selon les unités du projet. Dans un projet typique, citons :
Fichiers de projet (fichiers .DRP)
Contient le code source Pascal du programme principal du projet ;
Fichiers d'unité (fichiers .PAS)
Fichier source Pascal pour chaque formulaire du projet, comprenant toutes les déclarations et procédures du formulaire (y compris les procédures de traitement du temps) ;
Fichiers de formulaire (fichiers .DFM)
Un fichier binaire contenant les propriétés de conception d'un formulaire. Le fichier .DFM et le fichier .PAS de chaque formulaire se correspondent ;
Fichier de ressources (fichier .RES)
Fichiers de ressources binaires compilés qui sont liés au fichier exécutable de l'application ;
Fichier d'options du projet (fichier .DOF)
Stocke les options du projet définies par la commande de menu PProjet|Options ;
Fichier de paramètres du bureau (fichier .DSK)
Stocke les options du bureau définies par la commande de menu Outils|Options ;
Fichier de package (fichier .DPK/.BPL)
Fichiers utilisés pour partager des composants, des classes, des données et du code. Le fichier source est un fichier .DPK et après compilation c'est un fichier .BPL ;
définition constante
contenu:
Définition de valeurs logiques ;
Définition de valeur constante ;
Définition du code d'erreur ;
Format : Une définition par ligne. comme suit:
Const<constante> : type = valeur ; //Commentaire
illustrer:
Utilisez l'instruction Const pour déclarer des constantes utilisées à la place des valeurs littérales.
Exemple : Const C_SQL:string='select CH_USERER_ID from T_CD_USER' ; //Requête de l'ID utilisateur
Const C_PI:réel =3,1415926 ; //Pi
Définition du type de structure
Contenu : Définition du type de structure
Format:
Taper
<Nom du type>//Commentaires sur la description de la structure
<Nom de la variable 1> : type de variable ; //commentaires de description de la variable
<Nom de la variable 2> : type de variable ; //commentaires de description de la variable
…
Fin;
illustrer:
<Type name> est une chaîne commençant par une lettre majuscule. Les instructions définissant les types de variables dans la définition de structure commencent dans la deuxième ligne et la cinquième colonne.
Exemple:
taper
TableList=record //Définition du type d'unité de l'arborescence système
InID : entier ; //numéro d'unité
Nom : chaîne ; //Nom de l'unité
PID : chaîne ; //Nom de l'unité précédente
PT: PTableList; //Pointeur vers le type d'unité suivant
fin;
Style de programmation
Le style de programmation spécifie les règles de positionnement de chaque instruction et des commentaires dans le programme.
Style de fonction/procédure
<fonction/procédure> Nom (variable : type de variable [,...]);//description de la fonction/procédure
var
Variable 1 : type de variable ; // description de la variable
Variable 2 : Type de variable ; //Description de la variable
…
commencer
déclaration;
déclaration;
…
fin ;
Remarque : Les déclarations et instructions de variables sont écrites à partir de la troisième colonne. S'il y a une indentation, indentez-la de deux colonnes à la fois et alignez-la sur les instructions correspondantes.
style de déclaration
illustrer:
Il y a généralement un paragraphe de description de fonction toutes les dix lignes au maximum dans le corps du programme ;
Standardiser l'utilisation de diverses déclarations ;
L'indentation dans les instructions est en unités de deux colonnes.
instruction de définition de variable
var
var_name : <type de données> ;
déclaration d'affectation
nom_var : = <expression> ;
instruction conditionnelle
si condition alors //Commentaire
commencer
déclaration;
…
fin
sinon si condition alors // commentaire
commencer
déclaration;
...
fin
sinon//commentaire
déclaration;
Remarque : S'il n'existe qu'une seule instruction d'exécution, les instructions de début et de fin peuvent être omises.
Instruction de boucle
//Annotation de la fonction de boucle
pour le compteur := début à fin faire
commencer
[déclaration];
…
fin;
//Annotation de la fonction de boucle
tandis que [condition] fait
commencer
[déclaration];
…
fin;
//Annotation de la fonction de boucle
répéter
[déclaration];
…
jusqu'à [condition]
instruction de commutation
// description de la fonction de commutation
cas <expression> de
<valeur1> :[instruction 1] ;
<valeur2> :[instruction 2] ;
…
<valeur> : [instruction n]
fin;
Ligne de commentaire
Il doit y avoir des commentaires « Description du module » et « Description de l'unité » pour ce fichier d'unité en haut du fichier d'unité de code de programme.
Pour les parties de code significatives telles que les constantes, les types structurels, les fonctions/procédures, les variables personnalisées, les blocs fonctionnels de segments de code, les instructions clés, etc.
points, il doit y avoir une ligne de commentaire pour expliquer en détail.
La ligne de commentaire peut être ajoutée avec "//XXXXXXXX" après la ligne qui doit être expliquée, ou elle peut également être ajoutée au-dessus de la ligne qui doit être expliquée.
Ajoutez plusieurs lignes en utilisant "{XXXXXXXX}" ou ajoutez une seule ligne en utilisant "//XXXXXXXX".
Dénomination des fichiers et des formulaires
Signification du format de dénomination du nom de classe
Fichier de projet Programme (.DPR) XXXXX
UnitéUnité(PAS) uXXXXX
FormForm.Name(.DFM) XXXXXFrm
Module de donnéesDataModule XXXXXDM
Définition de l'en-tête d'unité, ajoutée devant chaque unité.
{************************************************* * ***
Nom de l'unité :
Description de la fonction :
auteur:
Nom du logiciel :
Version:
Nom de l’entreprise : Sword as Dream Software Creation Studio
************************************************** * *** }
Définition du format du numéro de version du logiciel :
Le logiciel utilise le format de numéro de version suivant : XXXX
Par exemple : une fois le programme disponible terminé, le numéro de version est marqué comme "1.0.0.0".
Le premier chiffre : numéro de version. Remarque : Il s'agit d'une version du logiciel qui a été considérablement améliorée.
Deuxième chiffre : numéro de maintenance. Remarque : Certaines erreurs ont été modifiées en fonction de la version existante.
Le troisième chiffre : numéro de patch. Remarque : Lorsque le programme corrige certaines erreurs et qu'aucun nouveau numéro de maintenance n'est généré, le numéro de correctif est utilisé.
Le quatrième chiffre : numéro de correction. Remarque : Lorsqu'une erreur de programme d'urgence se produit, le programme modifié est utilisé comme identifiant et non comme numéro de version du programme publié. yckxzjj