star-style

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

commit 623b401f9863170f605431ff564d7d289eb9e2e0
parent 2e28c11da06095986e2530453a484dae81b7a7d2
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 15 Jul 2026 11:06:31 +0200

Relecture

Diffstat:
Mdoc/fr/star-c.7 | 40++++++++++++++++++++++------------------
1 file changed, 22 insertions(+), 18 deletions(-)

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -1,6 +1,6 @@ -.\" Copyright (C) 2026 |Méso|Star> (contact@meso-star.com) +.\" Copyright (C) 2026 |Méso|Star> (contact@meso-star.com) .\" -.\" Ce fichier fait partie de Star-Style +.\" Ce fichier fait partie de Star-Style. .\" .\" Star-Style est un logiciel libre ; vous pouvez le redistribuer ou le .\" modifier suivant les termes de la GNU General Public License telle @@ -1143,14 +1143,14 @@ valide, au moins une valeur par défaut. Et d'ainsi éviter l'utilisation de variables non initialisées. 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 évoluer, sans que le code appelant n'est -forcément à s'en soucier dès lors que ses membres sont correctement -initialisés. +liste des membres peut changer, sans que le code appelant n'est +forcément à s'en soucier dès lors qu'ils sont correctement initialisés. Si elle existe, utiliser la constante proposée avec la structure pour initialiser une variable de ce type. .Pq voir section Sx LES CONSTANTES . En son absence n'initialiser que le premier membre de la variable ; le -language C assure alors que les autres membres seront initialisés à 0. +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 élément suffit à garantir que le reste du tableau sera initialisé à zero : @@ -1162,13 +1162,12 @@ int i = 0; .Ed .Pp Au sein d'une même fonction, définir les variables au plus proche de -leur utilisation de sorte à ce qu'un contexte resserré participe à les -caractériser. +leur utilisation de sorte à ce que le contexte dans lequel elles sont +utilisées participe à les caractériser. Par exemple, une variable -.Va i -utilisée dans un bloc comme variable temporaire, et comme indice -de boucle dans un autre gagnera en expressivité et en -robustesse à être définie localement à chaque bloc ; +.Va i utilisée dans un bloc comme variable temporaire, et comme indice +de boucle dans un autre gagnera en expressivité et en robustesse à être +définie localement à chaque bloc ; les deux variables étant, par construction, non seulement séparées mais aussi sans effet de bord de l'une sur l'autre : .Bd -literal -offset Ds @@ -1185,12 +1184,17 @@ if(foo) { Dans un même bloc, regrouper les définitions des variables dès lors qu'elles sont liés sémantiquements : .Bd -literal -offset Ds +/* Bibliothèque Foo */ +struct foo* foo = NULL; +struct foo_args foo_args = FOO_ARGS_DEFAULT; + /* Tableau à traiter */ double* liste = NULL; -int longueur_liste = 0; +int capacite = 0; +int longueur = 0; .Ed .Pp -Pour chaque groupe de variable, les définir par ordre décroissant de +Pour chaque groupe de variables, les définir par ordre décroissant de leur occupation mémoire a priori. Définir par exemple les variables structurées avant les variables de données simples. @@ -1199,7 +1203,7 @@ qui, pour garantir l'alignement des données eu égard à leur type, peuvent ajouter des octets de remplissage, augmentant ce faisant l'espace mémoire occupée par la fonction. Un sourcoût marginal qui néanmoins peut s'avérer significatif pour -des fonctions appeler récursivement. +des fonctions appelée récursivement. Ordonner les variables par ordre décroissant de leur taille mémoire tend à limiter le nombre d'octets de remplissage nécessaire, et donc le coût mémoire associé. @@ -1224,10 +1228,10 @@ 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 est utile pour définir la cardinalité d'un tableau, -comme valeur du dernier indice marquant la fin d'une itération, +Une telle constante peut alors servir à 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. +du type énumérée peut être vérifiée : .Bd -literal -offset Ds enum molecule { H2O,