Debian -->
[ document manifest ]
<< previous TOC next >>
< ^ >

Manuel Debian Live

Projet

14. Style du code

Ce chapitre documente le style du code utilisé en live-boot et autres.

14.1 Compatibilité

  • Ne pas utiliser la syntaxe ou la sémantique qui sont uniques à le shell Bash. Par exemple, l'utilisation de structures de tableau.
  • N'utiliser que le sous-ensemble POSIX - par exemple, utiliser $(foo) au lieu de `foo`.
  • Vous pouvez vérifier vos scripts avec 'sh -n' et 'checkbashisms'.
  • 14.2 Indentation

  • Toujours utiliser des tabulations en lieu des espaces.
  • 14.3 Adaptateur

  • Généralement, les lignes sont de 80 caractères au maximum.
  • Utilisez le «style Linux» des sauts de ligne:
  • Mal:

    if foo; then
             bar
    fi

    Bien:

    if foo
    then
             bar
    fi

  • La même chose vaut pour les fonctions:
  • Mal:

    foo () {
             bar
    }

    Bien:

    foo ()
    {
             bar
    }

    14.4 Variables

  • Les variables sont toujours en lettres majuscules.
  • Les variables utilisées dans lb config commencent toujours par le préfixe LB_.
  • Les variables temporaires internes en live-build devraient commencer avec le préfixe _LB_.
  • Les variables locales commencent avec le préfixe __LB_.
  • Les variables en relation avec un paramètre de démarrage en live-config commencent par LIVE_.
  • Toutes les autres variables en live-config commencent par le préfixe _.
  • Utilisez des accolades autour des variables; par exemple écrire ${FOO} au lieu de $FOO.
  • Toujours protéger les variables avec guillemets pour respecter les espaces potentiels: écrire "${FOO}" en lieu de ${FOO}.
  • Pour des raisons de cohérence, toujours utiliser les guillemets lors de l'attribution des valeurs aux variables:
  • Mal:

    FOO=bar

    Bien:

    FOO="bar"

  • Si plusieurs variables sont utilisées, utiliser les guillemets pour l'expression complète:
  • Mal:

    if [ -f "${FOO}"/foo/"${BAR}"/bar ]
    then
             foobar
    fi

    Bien:

    if [ -f "${FOO}/foo/${BAR}/bar" ]
    then
             foobar
    fi

    14.5 Autres

  • Utilisez "|" (sans les guillemets autour) comme un séparateur dans les appels à sed, par exemple "sed -e 's|foo|bar|'" (sans" ").
  • Ne pas utiliser la commande test pour des comparaisons ou des tests, utilisez "[" "]" (sans ""); par exemple "if [ -x /bin/foo ]; ..." et non pas "if test -x /bin/foo; ...".
  • Utiliser case dans la mesure du possible en lieu de test, parce qu'il est plus facile à lire et plus rapide dans l'exécution.

  • [ document manifest ]
    << previous TOC next >>
    < ^ >