Précédent: , Monter: Style de code   [Table des matières][Index]


22.5.4 Formatage du code

Lorsque nous écrivons du code Scheme, nous suivons la sagesse commune aux programmeurs Scheme. En général, nous suivons les règles de style de Riastradh. Ce document décrit aussi les conventions utilisées dans le code de Guile. Il est bien pensé et bien écrit, alors n’hésitez pas à le lire.

Certaines formes spéciales introduites dans Guix comme la macro substitute* ont des règles d’indentation spécifiques. Elles sont définies dans le fichier .dir-locals.el qu’Emacs utilise automatiquement. Remarquez aussi qu’Emacs-Guix fournit le mode guix-devel-mode qui indente et colore le code Guix correctement (voir Development dans The Emacs-Guix Reference Manual).

Si vous n’utilisez pas Emacs, assurez-vous que votre éditeur connaisse ces règles. Pour indenter automatiquement une définition de paquet, vous pouvez aussi lancer :

./pre-inst-env guix style paquet

Voir Invoquer guix style, pour plus d’informations.

Si vous éditez du code avec Vim, nous recommandons de lancer :set autoindent pour que votre code soit automatiquement indenté au moment où vous l’entrez. En plus, paredit.vim peut vous aider à gérer toutes ces parenthèses.

Nous demandons que toutes les procédure de premier niveau contiennent une chaîne de documentation. Ce prérequis peut être relâché pour les procédures privées simples dans l’espace de nom (guix build …) cependant.

Les procédures ne devraient pas avoir plus de quatre paramètres positionnés. Utilisez des paramètres nommés pour les procédures qui prennent plus de quatre paramètres.