star-style

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

commit 35f45e7b39e88d13f5f2628c11ad13591b837bce
parent 03f593c1a7aaeab0d981b88419823e7d650224ca
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Thu, 25 Jun 2026 18:39:48 +0200

Relecture

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

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -15,7 +15,7 @@ .\" Vous devez avoir reçu une copie de la GNU General Public License en .\" même temps que Star-Style ; si ce n'est pas le cas, consultez .\" <http://www.gnu.org/licenses>. -.Dd June 23, 2026 +.Dd June 25, 2026 .Dt STAR-C 7 .Os .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" @@ -104,7 +104,7 @@ besoin, pour notamment pouvoir utiliser des fonctions de la bibliothèque C standard sinon indisponibles via la seule norme du langage retenue. .Pp Pour ce faire, définir la macro -.Ql _POSIX_C_SOURCE +.Sy _POSIX_C_SOURCE tout en haut du fichier C concerné, avant la moindre directive d'inclusion. Par exemple, pour utiliser le standard POSIX.1-2001 : @@ -166,7 +166,7 @@ en référence à l'extension .Ql .h du fichier. Dans l'exemple qui précède, le garde-fou concerne donc le fichier -.Pa foo.h . +.In foo.h . La convention d'écriture est sinon celle utilisée pour n'importe quelle macro .Pq section Sx LES MACROS . @@ -392,7 +392,7 @@ qui résume la séquence de code qui suit : .Pp ou à l'échelle du fichier, où les commentaires servent alors de séparateur entre ses différentes sections -.Pq voir LA STRUCTURE D'UN FICHIER SOURCE . +.Pq voir Sx LA STRUCTURE D'UN FICHIER SOURCE . Dans ce cas, encadrer le commentaire par deux ligne de caractères .Ql * qui débute ou se termine par le caractère @@ -443,9 +443,9 @@ les en-têtes systèmes et de la bibliothèque C standard. 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 +en-têtes dont il a lui même besoin, indépendemment des directives +d'inclusion qui précèdent sa propre inclusion. +Si ce 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 @@ -456,6 +456,7 @@ est inclu. .Bd -literal -offset Ds #include "bar.h" #include "foo.h" +#include "qux.h" #include <baz.h> @@ -465,7 +466,7 @@ est inclu. .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é à +par exemple par une déclaration anticipée des types structurés à 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 @@ -473,9 +474,9 @@ 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. +reduire les temps de compilation. .Pp -.\"""""""""""""""""""""""""""""""""" +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .Sh LA VISIBILITÉ DES SYMBOLES .Sh LES BLOCS .Sh LES MOTS CLÉS