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


14.5.4 Formatage du code

When writing Scheme code, we follow common wisdom among Scheme programmers. In general, we follow the Riastradh’s Lisp Style Rules. This document happens to describe the conventions mostly used in Guile’s code too. It is very thoughtful and well written, so please do read it.

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 Développement 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 :

./etc/indent-code.el gnu/packages/file.scm package

Cela indente automatiquement la définition de package dans gnu/packages/file.scm en lançant Emacs en mode commande. Pour indenter un fichier complet, n’indiquez pas de second argument :

./etc/indent-code.el gnu/services/file.scm

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 par mot-clefs pour les procédures qui prennent plus de quatre paramètres.


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