Documentation PostgreSQL 15.15 » Internes » Conventions de codage pour PostgreSQL » Formatage

Précédent | Niveau supérieur | Suivant
Chapitre 56. Conventions de codage pour PostgreSQL | Sommaire | 56.2. Reporter les erreurs dans le serveur

## 56.1. Formatage

Le formatage du code source utilise un espacement de quatre colonnes pour les tabulations, avec préservation de celles-ci (c'est-à-dire que les tabulations ne sont pas converties en espaces). Chaque niveau logique d'indentation est une tabulation supplémentaire.

Les règles de disposition (positionnement des parenthèses, etc.) suivent les conventions BSD. En particulier, les accolades pour les blocs de contrôle `if`, `while`, `switch`, etc. ont leur propre ligne.

Limiter la longueur des lignes pour que le code soit lisible avec une fenêtre de 80 colonnes. (Cela ne signifie pas que vous ne devez jamais dépasser 80 colonnes. Par exemple, diviser un long message d'erreur en plusieurs morceaux arbitraires pour respecter la consigne des 80 colonnes ne sera probablement pas un grand gain en lisibilité.)

Pour maintenir un style de codage cohérent, ne pas utiliser les commentaires style C++ (`//`). pgindent les remplacera par `/* ... */`.

Le style préféré pour les blocs multilignes de commentaires est :

    /*
     * le commentaire commence ici
     * et continue ici
     */

Notez que les blocs de commentaire commençant en colonne 1 seront préservés par pgindent, mais qu'il déplacera (au niveau de la colonne) les blocs de commentaires indentés comme tout autre texte. Si vous voulez préserver les retours à la ligne dans un bloc indenté, ajoutez des tirets comme ceci :

        /*----------
         * le commentaire commence ici
         * et continue ici
         *----------
         */

Bien que les correctifs (patchs) soumis ne soient absolument pas tenus de suivre ces règles de formatage, il est recommandé de le faire. Le code est passé dans pgindent avant la sortie de la prochaine version, donc il n'y a pas de raison de l'écrire avec une autre convention de formatage. Une bonne règle pour les correctifs est de « faire en sorte que le nouveau code ressemble au code existant qui l'entoure ».

Le répertoire `src/tools/editors` contient des fichiers d'exemples de configuration qui peuvent être employés avec les éditeurs Emacs, xemacs ou vim pour valider que le format du code écrit respecte ces conventions.

Si vous voulez exécuter pgindent localement pour aider à rendre votre code plus proche du style du projet, voir le répertoire `src/tools/pgindent`.

Les outils de parcours de texte more et less peuvent être appelés de la manière suivante :

    more -x4
    less -x4

pour qu'ils affichent correctement les tabulations.