rougail/doc/dictionary/convention.md

21 lines
657 B
Markdown
Raw Normal View History

2023-10-12 08:17:30 +02:00
---
gitea: none
include_toc: true
---
2021-12-11 16:33:55 +01:00
2023-10-12 08:17:30 +02:00
# Conventions
2021-12-11 16:33:55 +01:00
2023-10-12 08:17:30 +02:00
## Convention de nom d'un fichier de dictionnaire
2021-12-11 16:33:55 +01:00
2022-11-10 22:58:24 +01:00
L'ordre des dictionnaires est important pour l'ordre de création des variables et des familles.
Les fichiers devront donc démarrés par deux numéros suivit d'un tiret.
2023-10-12 08:17:30 +02:00
Par exemple : `00-base.xml`
2022-11-10 22:58:24 +01:00
2023-10-12 08:17:30 +02:00
## Convention du nom des familles et variables
2022-11-10 22:58:24 +01:00
2023-10-12 08:17:30 +02:00
La seule restriction sur le nom des familles et variables est que le nom ne doit pas commencer par le caractère "\_".
Néanmoins il est préférable de n'utiliser que des lettres minuscule ASCII, des chiffres et le caractère "\_".
C'est la convention typographique snake case qui est donc utilisée.