mirror of https://framagit.org/kyodev/kyopages.git
2.6 KiB
2.6 KiB
général
- utf-8
- indentation: TABULATION
- $() t pas `
- pas de commandes séquentielle avec ;
- pas conditions compactes (condition&&action||action), par lisibilité, lors affectation variables
- == pour marquer les équivalences, = pour les assignations, bien que = pourraient être utilisées pour les équivalences
- même si [[ permettrait d'éviter les guillemets, il sont quand même mis par convention, ne serait ce que pour une coloration syntaxique homogène
fonctions
sauf exception (initialisation), les fonctions utilisent ce principe de nommage:
-
f__ : fonctions utilitaires, communes à plusieurs scripts
- variables publiques: pas de conventions de nommage pour l'instant (à faire)
- à faire : fu_ (Utilité)
- variables publiques: pas de conventions de nommage pour l'instant (à faire)
-
f_ : fonction généraliste propre au script
- variables publiques: AUCUNE
-
fi_ : affichage/présentation
- variables publiques: $fe_ (Exception)
- éviter les variables publiques
- exceptions: sous-fonctions, sortie pour lisibilité, variables n'a pas à respecter le nommage (sous-fonction)
-
figet_ : calculs/préparation
- variables publiques: $fg_ (Général)
- aucun affichage
variables
- toutes les variables internes à la fonction doivent être déclarées en local en tête de fonction
- les variables publiques sont signalées en première lignes de commentaire au-dessus de la déclaration de fonction
- nommage
- fg_ : pour une variable de fonction figet_
- fe_ : pour une variable de fonction f_ (attention aux collisions avec un nom de fonction)