Commentaires

1. Différence des commentaires de template

Syntaxe	Type	Caractéristiques
<!-- Commentaire HTML -->	Commentaire natif HTML	Apparaît dans le code source final de la page web, visible dans l’inspecteur du navigateur
## Commentaire sur une ligne	Commentaire Velocity une ligne	Interprété uniquement par le moteur, non affiché sur la page, valable jusqu’à la fin de la ligne
#* Contenu du commentaire multi‑lignes *#	Commentaire multi‑lignes Velocity	Prend en charge les sauts de ligne, non affiché sur la page

Conseil de développement : privilégiez ## / #* *# pour les commentaires métiers, afin d’éviter de divulguer des informations dans le code source de la page.

2. Règles de nommage des variables

Règles de base officielles

1. Le premier caractère d’une variable doit être une lettre (a‑z / A‑Z)
2. Caractères autorisés ensuite : lettres, chiffres 0‑9, underscore _, tiret -

Ambiguïté de l’opérateur avec le tiret -

#set($name-d = "test")Langage du code : PHP (php)

Cette écriture génère une erreur à l’exécution : Encountered "name" ... Was expecting one of:
Cause : Velocity interprète le - comme opérateur de soustraction !
Le moteur analyse l’expression comme $name - d, c’est‑à‑dire la variable $name moins la variable d, ce qui crée un conflit syntaxique.

Deux solutions possibles :

1. Recommandé : utiliser l’underscore (pas d’ambiguïté, convention habituelle)

#set($name_d = "hello world")Langage du code : PHP (php)

2. Délimiter la variable avec des accolades (prend en charge les noms contenant un tiret)

#set(${name-d} = "hello world")
${name-d}Langage du code : PHP (php)

Exemples valides / invalides

# ✅ Valide
#set($name_d = "underscore")
#set($name12d = "lettre suivie de chiffres")
#set(${name-1_2d} = "tiret : accolades obligatoires")

# ❌ Tirets sans accolades → erreur d’analyse
#set($name-d = "Erreur !")
#set($name-1_2d = "Erreur !")Langage du code : PHP (php)

3. Règles de syntaxe de #set

Écriture standard (espaces autour des parenthèses libres, garder un style cohérent)

#set($nomVariable = "valeur")Langage du code : PHP (php)

Les chaînes de caractères doivent être entre guillemets doubles ; conserver des espaces autour du signe égal améliore la lisibilité.

Commentaires