star-style

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

commit fdc9e02dd25a1e4eb4b054bb899a50038c2d446b
parent c154df58b4d5566dd42ce65b85994f9bd80f39a7
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Tue, 23 Jun 2026 10:46:41 +0200

Ajoute la section sur l'indentation

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

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -294,6 +294,70 @@ est : * <https://www.gnu.org/licenses/>. */ .Ed .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.Sh L'IDENTATION +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 encourgés à configurer leur éditeur 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 +Limiter l'indentation à 2 caractères, contre 8 pour le standard de facto +des tabulations, laisse plus d'espace aux différents niveaux +d'indentation, dès lors moins contraints par la limite du nombre de +caractères par ligne +.Pq section Sx LA LONGUEUR DES LIGNES . +Néanmoins, un niveau d'indentation supèrieur à 3 est aussi le signe d'un +déficit de structure dans l'écriture du programme. +Les 2 espaces retenus pour indenter le code n'est donc pas une +incitation à aller au delà de 3 niveaux d'indentation sous prétexte de +disposer de plus d'espace par niveau. +.Pp +Indenter le contenu de chaque bloc +.Pq section Sx LES BLOCS . +Pour la directive +.Ql switch , +identer chaque +.Ql case +ainsi que leur contenu : +.Bd -literal -offset Ds +switch(opt) { + case 'e': + errno = 0; + epsilon = strtod(optarg, NULL); + if(errno != 0) err = 1; + break; + case 'h': + printf("usage: foo [-hov]\en"); + break; + case 'o': + output = optarg; + break; + case 'v': + verbose += (verbose < 3); + break; + default: + err = 1; + break; +} +.Ed +.Pp +Motiver l'utilisation de plusieurs instructions par ligne par +l'expressivité du code en résultant, qu'une écriture resserrée viendrait +renforcer : +.Bd -literal -offset Ds +if(x == NULL || y == NULL) { err = 1; goto error; } +x[0] = 1.0; x[1] = 0.0; +y[0] = 0.0; y[1] = 1.0; +.Ed +.Pp +Ne sauter au plus qu'une ligne. +Ne pas laisser d'espace en fin de ligne et supprimer les lignes vides +en fin de fichier. +.Pp +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .Sh LES COMMENTAIRES .Sh LES FICHIERS D'EN-TÊTE .Sh LA VISIBILITÉ DES SYMBOLES