star-style

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

commit 664ce75d4abb94fce1efa1e2c78df15b896b960b
parent 544dfba84271e0aa142b25bb9b908996ba266db1
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Thu, 16 Jul 2026 09:59:23 +0200

Relecture

Diffstat:
Mdoc/fr/star-c.7 | 31+++++++++++++++----------------
1 file changed, 15 insertions(+), 16 deletions(-)

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -1013,9 +1013,9 @@ Utiliser le même suffixe en double tirets bas pour nommer les variables internes à une macro, afin d'éviter de masquer les variables définies dans le contexte où la macro est développée : .Bd -literal -offset Ds -#define FOO(Bar, N) { \e - int i__; \e - for (i__ = 0; i__ < N; Bar(i__), ++i__); \e +#define FOO(Bar, N) { \e + int i__; \e + for (i__ = 0; i__ < N; Bar(i__), ++i__); \e } (void)0 .Ed .Pp @@ -1024,12 +1024,12 @@ Suffixer les macros d'un fichier d'en-tête par deux tirets bas dès lors qu'elles sont propres au fichier d'en-tête, et donc vraisemblablement inacessibles au delà : .Bd -literal -offset Ds -#define FOO__(Type, Dim) \e - struct Type { - int i[Dim]; - float f[Dim]; +#define FOO__(Type, Dim) \e + struct Type { \e + int i[Dim]; \e + float f[Dim]; \e } -FOO__(bar, 2) +FOO__(bar, 2); FOO__(baz, 3); FOO__(qux, 4); #undef FOO__ @@ -1223,7 +1223,7 @@ l'énumé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é peut être vérifiée : .Bd -literal -offset Ds enum molecule { CH4, @@ -1273,20 +1273,20 @@ static const struct qux QUX_DEFAULT = QUX_DEFAULT__; .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .Sh LES STRUCTURES Définir les structures en en-tête de fichier -.Pq section Sx LA STRUCTURE D'UN FICHIER SOURCE . +.Pq section Sx LA STRUCTURE D'UN FICHIER SOURCE , +à l'exeption des structures locales à une fonction. .Pp Lister les variables membres d'une structure suivant la même convention que pour la définition des variables d'un bloc .Pq section Sx LES VARIABLES Ns  : -Les regrouper d'abord par sémantique, puis les trier par occupation +les regrouper d'abord par sémantique, puis les trier par occupation mémoire décroissante, et enfin par ordre alphabétique. .Pp Ne définir qu'une variable membre par ligne. .Pp Pour une structure dont aucune fonction ne permet d'en initialiser les -variables membres, définir une constante qui fixe leur valeur par défaut -.Pq section Sx LES CONSTANTES . +membres, définir une constante qui fixe leur valeur par défaut. Suffixer cette constante par .Ql DEFAULT ou @@ -1313,11 +1313,10 @@ static const struct chaine CHAINE_NULL = CHAINE_NULL__; Éviter d'utiliser une déclaration typedef des structures afin d'autoriser leur déclaration anticipée. Et l'utilisation de pointeur vers une donnée structurée sans avoir en à -connaitre la représentation mémoire -.Pq structures opaques . +connaitre la représentation mémoire. Si un déclaration typedef est néanmoins souhaitée, nommer le type structuré en suivant la convention de nommage des déclarations typedef -.Pq section Sx LE NOMMAGE . +.Pq section Sx Les déclarations de types . .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .Sh LES MACROS .Sh LES ALLOCATIONS DYNAMIQUES