star-style

Writing conventions for co-authors
Log | Files | Refs | README | LICENSE

commit 10d9bce24136f1d2d5125dcbbcc88593d3b20610
parent 2ef023abc1e2ed9263751f255f3dae97089d8b03
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Mon, 31 Aug 2026 16:45:56 +0200

Relecture

Diffstat:
Mdoc/fr/star-c.7 | 27++++++++++++++-------------
1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -74,7 +74,7 @@ la license du projet qui liste ses conditions légales d'utilisation ; .Pa config.mk et .Pa Makefile -les fichiers du système de génération automatique ; +les fichiers du système de génération automatique du projet ; .It .Pa src/ le répertoire qui contient les codes source du projet ; @@ -142,7 +142,7 @@ programme  ; .\"""""""""""""""""""""""""""""""""" .It -La définition d'une macro qui ajoute au langage C du fichier le support +La définition des macros qui ajoute au langage C du fichier le support d'un standard POSIX .Pq section Sx LE LANGAGE C Ns  ; @@ -159,7 +159,7 @@ Il est fermé en toute fin du fichier .Ed .Pp Le nom de la macro testée puis définie est celui du fichier d'en-tête, -suffixé par +en majuscule, suffixé par .Ql _H en référence à l'extension .Ql .h @@ -257,7 +257,7 @@ Chaque copyright débute par le mot en anglais, suivi des 3 caractères .Ql (C) , traduction ASCII du caractère © qui, quant à lui, peut ne pas être -supporté par les jeu de caractères utilisé. +supporté par la police de caractères utilisée. Lister ensuite les années pour lesquelles une version du programme a été publiée, avant le nom de l'auteur(e) ayant participé(e) à sa réalisation. @@ -302,8 +302,8 @@ Indenter le texte par 2 espaces. La mise en page du texte, taille de ligne comprise, est ce faisant indépendante de la taille d'une tabulation. .Pp -Les auteurs sont encouragés à configurer leur éditeur pour -qu'il développe chaque caractère tabulation en 2 espaces +Les auteures et auteurs sont encouragés à configurer leur éditeur de +texture pour qu'il développe chaque caractère tabulation en 2 espaces .Pq section Sx FICHIERS . Et ainsi continuer à utiliser la touche tabulation pour l'indentation. .Pp @@ -984,7 +984,7 @@ pour nommer les arguments des macros ; les termes qui composent leur nom sont séparés par une variation de la casse typographique. Un terme débute par une majuscule, suivi de caractères -alphanumériques en minuscule. +alphanumériques en minuscules. .Bd -literal -offset Ds #define FOO_BAR(FooBar, Qux) ((FooBar) + (Qux)) .Ed @@ -1087,10 +1087,7 @@ ainsi identifiables par la seule mise en page de sa déclaration. .Pp Lors de sa définition, lister les arguments de la fonction sur la même ligne que le nom de la fonction, sans ajouter d'espace entre le nom de -la fonction et sa parenthèse ouvrante. -Si la liste des arguments dépasse la longueur maximale d'une ligne -.Pq section Sx LA LONGUEUR DES LIGNES -lister les arguments comme pour une déclaration : +la fonction et sa parenthèse ouvrante : .Bd -literal -offset Ds void foo_bar(struct foo* foo, const int qux, const float xyzzy) @@ -1099,6 +1096,10 @@ foo_bar(struct foo* foo, const int qux, const float xyzzy) } .Ed .Pp +Si la liste des arguments dépasse la longueur maximale d'une ligne +.Pq section Sx LA LONGUEUR DES LIGNES +les lister comme pour une déclaration. +.Pp Ordonner les arguments d'une fonction comme suit : .Bl -enum -compact .It @@ -1181,9 +1182,9 @@ D'apparence peu critique pour les variables de type primitif, cette initialisation l'est bien plus pour les variables structurées, dont la liste des membres peut changer. Si elle existe, utiliser la constante proposée avec la définition du -type structuré pour initialiser une variable de ses variables +type structuré pour initialiser ses membres .Pq voir section Sx LES STRUCTURES . -En son absence n'initialiser que le premier membre de la variable ; le +En son absence, n'initialiser que le premier membre de la variable ; le language C assure alors que les autres membres seront initialisés à zéro. De même pour un tableau alloué sur la pile, initialiser son premier