star-style

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

commit 43594af3ec1a20c5536fdee5d6274d5324b13dc0
parent ce9a2f4a4a059985c3c00f56841606bc7523a0b5
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Mon, 13 Jul 2026 16:48:33 +0200

Relecture

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

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -1049,7 +1049,7 @@ De même, un nombre de variables locales supérieur à dix peut être le signe d'une fonction trop dense. .Pp Écrire les directives qui contrôlent la portée d'une fonction et son -type de retour, sur une ligne séparée de son nom. +type de retour sur une ligne séparée de son nom. L'expression régulière .Ql ^nom_de_fonction peut ainsi être utilisée pour la recherche d'une fonction dans les @@ -1058,7 +1058,7 @@ différents fichiers sources. Pour une déclaration, revenir à la ligne avant d'ouvrir la parenthèse de la fonction, précédée d'une indentation par rapport au nom de la fonction sur la ligne qui précède. -Puis lister les arguments de la fonction, en revenant à la ligne après +Puis, lister les arguments de la fonction, en revenant à la ligne après chacun d'eux et en les alignant les uns par rapport aux autres. Ajouter la parenthèse fermante .Ql \&) @@ -1077,7 +1077,8 @@ Les différentes parties qui composent le profil de la fonction sont 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. +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 : @@ -1106,12 +1107,12 @@ aux variables qui n'ont pas vocation à être modifiées par la fonction. Et ce quand bien même leur modification n'aurait aucune conséquence, comme pour les variables de données simples, copiées à l'appel de la fonction. -L'objet étant d'expliciter quelles sont les variables d'entrée de la -fonction. +L'objet étant de souligner quelles sont des variables en entrée : .Bd -literal -offset Ds static void foo - (struct foo* f, + (struct foo* foo, + constr struct bar* bar, const int longueur, const int* liste, int* resultat); @@ -1139,13 +1140,14 @@ enum attribut { TEXCOORD }; .Ed +.Pp Pour une énumération qui utilise des valeurs par défaut, ajouter si besoin une dernière constante qui définit le nombre de constantes valides ; sa valeur sera ainsi automatiquement mise à jour à chaque changement de l'énumération. -Une telle constante peut s'avérer utilie au titre de cardinalité d'un tableau, -de valeur du dernier indice marquant la fin d'une itération, +Une telle constante est utile pour définir la cardinalité d'un tableau, +comme valeur du dernier indice marquant la fin d'une itération, ou encore comme valeur vis à vis de laquelle la validité d'une variable du type énumérée peut être vérifiée. .Bd -literal -offset Ds @@ -1161,7 +1163,8 @@ enum molecule { }; /* Vérifier qu'une constante définie une molecule valide */ -#define MOLECULE_EST_VALIDE(Mol) ((unsigned)(Mol) < NOMBRE_DE_MOLECULES) +#define MOLECULE_EST_VALIDE(Mol) \e + ((unsigned)(Mol) < NOMBRE_DE_MOLECULES) static const char* NOM_DES_MOLECULES[NOMBRE_DE_MOLECULES] = { "H2O", "CO2", "O3", "N2O", "CO", CH4 @@ -1182,8 +1185,8 @@ static const struct foo FOO_DEFAULT = FOO_DEFAULT__; .Ed .Pp N'utiliser la macro que lorsqu'il est impossible d'utiliser la variable -constante, en l'occurence, pour initialiser à la définition d'une autre -structure une variable membre de ce type. +constante, en l'occurence pour initialiser, dès sa définition, les +membres d'une variable structurée : .Bd -literal -offset Ds struct qux { struct foo foo;