Les conventions

L'enregistrement de certains éléments passe par une annotation de classe. Cette annotation, qu'elle soit @Event, @Expression, @Action ou encore @Native demande des paramètres spécifiques permettent d'identifier chaque nouvel élément. Cependant, certains paramètres ne sont utiles que pour permettre une meilleure documentation ainsi qu'un meilleure lecture du code. C'est le cas le plus souvent pour les paramètres name, description et examples.

Nom des éléments

Chaque classe permettant la reconnaissance de plusieurs patterns (sauf pour les évènements), il est recommandé de configurer le paramètre name de la manière suivante :

name = "Ce sur quoi agit la classe de manière générale" + "<Type de l'élément>"

Par exemple, pour les fonctions mathématiques, on configure name à "Math Functions" .

Pour les expressions agissant sur les tableaux, on configure name à "Arrays Expressions".

Description des éléments

Aucune particularité n'est demandée ici. Il faut simplement être le plus concis et le plus clair possible, pour qu'il soit possible de comprendre ce que fait cette classe.

Examples des éléments

En ce qui concerne les exemples, vous pouvez en mettre autant que vous voulez, mais il est inutile d'en fournir un pour chaque pattern. L'idée est de montrer un résumé de ce qu'il est possible de faire, sur 5 ou 6 patterns. On préférera ne pas insérer de phrases dans les exemples, ou de commentaires, simplement du code qu'il est possible d'ajouter à un script.