Embarcadero vient de publier sur le site docwiki une version mise à jour du guide de style de langue. Le document a été mis à jour pour couvrir les fonctionnalités du langage Delphi moderne et certaines modifications du style de codage
Au cours des derniers mois, je me suis efforcé de publier un nouveau guide de style Object Pascal pour le langage Delphi actuel. De la préface:
«Ce document est une version mise à jour du guide de style Object Pascal classique, initialement organisé par Charlie Calvert pour Borland au moment de la sortie de Delphi. La version mise à jour a été organisée par Marco Cantu, chef de produit Delphi, avec les contributions de l’équipe R&D interne, des MVP Delphi et de la communauté Delphi dans son ensemble. »
Le texte n’est pas un guide de langage, il couvre plutôt l’utilisation des espaces blancs et le formatage lors de l’écriture de code – ce que le compilateur ignore généralement. Rien n’est obligatoire ici, c’est juste une recommandation pour favoriser la lisibilité. Le respect de ces règles est une exigence de notre propre équipe interne et de tout contributeur.
Vous pouvez trouver le guide de style sur http://docwiki.embarcadero.com/RADStudio/Sydney/en/Delphi’s_Object_Pascal_Style_Guide .
Voici l’index des documents:
- introduction
- Règles générales: identifiants, mots clés, indentation
- Fichiers de code source, unités et leur structure
- Utilisation de l’espace blanc
- commentaires
- Déclarations
- Déclarations de type
Je terminerai ce blog en publiant la courte introduction:
Alors que les compilateurs Delphi ignorent généralement tout espace blanc et permettent une grande flexibilité dans la façon dont un développeur écrit le code, pour la lisibilité et la maintenabilité du code source, Embarcadero a défini un ensemble de directives utilisées par la R&D interne et tout développeur impliqué dans le projet. Nous recommandons à la communauté Delphi dans son ensemble d’adopter ce style de codage et de formatage.
L’introduction de la version originale de ce document l’exprime bien:
«Object Pascal est un langage magnifiquement conçu. Une de ses grandes vertus est sa lisibilité. Ces normes sont conçues pour améliorer la lisibilité du code Object Pascal. Lorsque les développeurs suivront les conventions simples énoncées dans ce guide, ils feront la promotion de normes qui profiteront à tous les développeurs Delphi en utilisant un style uniforme et facile à lire. Les efforts visant à appliquer ces normes augmenteront la valeur du code source d’un développeur, en particulier pendant les cycles de maintenance et de débogage. »
Ce document ne fait pas référence ni n’explique la syntaxe et la grammaire du langage, car il se concentre uniquement sur la définition du style d’écriture de code dans les endroits où la langue vous donne le choix, en permettant de nombreuses options différentes en termes d’espaces blancs et de formatage.
Aucune de ces lignes directrices n’est gravée dans le marbre et nous nous attendons à ce qu’elles évoluent avec le temps avec la langue.
Design. Code. Compile. Deploy.
Start Free Trial Upgrade Today
Free Delphi Community Edition Free C++Builder Community Edition
