star-style

commit 03f593c1a7aaeab0d981b88419823e7d650224ca
parent 12859673474ca2edffddebd410cfda4fccd091f5
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Tue, 23 Jun 2026 17:24:21 +0200

Ajoute la section sur les fichiers d'en-tête

Diffstat:
M
doc/fr/star-c.7
 | 
46
++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 46 insertions(+), 0 deletions(-)
diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7
@@ -430,6 +430,52 @@ commentaires sur une ligne séparée :
 .Ed
 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Sh LES FICHIERS D'EN-TÊTE
+Inclure les fichiers d'en-tête dans l'ordre qui suit :
+.Bl -enum -compact
+.It
+les en-têtes locaux au programme ;
+.It
+les en-têtes des dépendances ;
+.It
+les en-têtes systèmes et de la bibliothèque C standard.
+.El
+.Pp
+Les fichiers d'en-tête sont ainsi inclus dans l'ordre inverse de leur
+niveau d'abstraction.
+Cet ordre participe à garantir que chaque fichier d'en-tête inclu les
+en-têtes dont il a lui même besoin, indépendemment des directive
+d'inclusion qui précède sa propre inclusion.
+Si tel n'est pas le cas, la compilation pourra échouer, symptôme qu'un
+des fichiers d'en-tête n'est pas auto-consistant.
+.Pp
+Dans chaque groupe, trier les directives d'inclusion par ordre
+alphabétique des fichiers d'en-tête.
+Si besoin, ajouter un commentaire court, sur la même ligne que la
+directive d'inclusion, qui explicite la raison pour laquelle la fichier
+est inclu.
+.Bd -literal -offset Ds
+#include "bar.h"
+#include "foo.h"
+
+#include <baz.h>
+
+#include <float.h> /* FLT_MAX */
+#include <stdio.h>
+.Ed
+.Pp
+S'efforcer de n'inclure que les seuls fichiers d'en-tête
+réellement nécessaires au fichier ;
+par exemple en utilisant les déclarations anticipées de type structuré à
+la place d'inclure des en-têtes dans le seul but de déclarer lesdits
+types.
+Un enjeu a considérer avec d'autant plus d'attention que le fichier
+concerné par les inclusions est lui même un fichier d'en-tête, par
+conséquent amené à être lui même inclu.
+L'objet étant de limiter autant que possible le nombre de fichiers
+inclus par unité de compilation, pour limiter les accés disque et ainsi
+accélérer les temps de compilation.
+.Pp
+.\""""""""""""""""""""""""""""""""""
 .Sh LA VISIBILITÉ DES SYMBOLES
 .Sh LES BLOCS
 .Sh LES MOTS CLÉS