Différences

Ci-dessous, les différences entre deux révisions de la page.

--- 2_programmation:macros:bien_nommer_ses_macros_et_environnements [2017/03/14 08:08]
mpg créée
+++ 2_programmation:macros:bien_nommer_ses_macros_et_environnements [2020/12/01 13:50]
yannick.tanguy Renommage des sections de base: correction des liens internes.
@@ Ligne 1: / Ligne 1: @@
-====== Bien nommer ses macros et environnements ======
+====== Comment bien nommer ses commandes et environnements ? ======
-La première chose chose à savoir pour nommer ses macros où environnements est quels sont les noms autorisés. Pour les macros, ils sont de deux types : les caractères de contrôle et les mots de contrôle. Dans un caractère de contrôle (//p. ex.// ''\!''), la contre-oblique est suivie d'un unique caractère qui n'est pas une lettre. Dans un mot de contrôle, la contre-oblique est suivie d'une suite de lettres et le nom de la commande se termine au premier caractère non-lettre (typiquement un espace ou une accolade).
+===== Les caractères autorisés dans les noms =====
-TeX reconnaît les 52 caractères auxquels vous pensez comme des lettres. En particulier, ''A'' et ''a'' sont différents, et ''é'', ''@'' ou ''1'' ne sont pas des lettres. On peut parfois demander à TeX de changer sa notion de lettre : voir par exemple le cas de ''\makeatletter''.
+Les commandes classiques sont de deux types :
+  * les caractères de contrôle. Dans ce cas, la contre-oblique est suivie d'un unique caractère qui n'est pas une lettre (par exemple ''\!'') ;
+  * les mots de contrôle. Là, la contre-oblique est suivie d'une suite de lettres et le nom de la commande se termine au premier caractère non-lettre (typiquement un espace ou une accolade).
-Pour les noms d'environnements, c'est plus simple : les caractères autorisés sont les lettres et le caractère ''*'' et ce, quelle que soit la longueur. Vous pouvez essayer d'utiliser d'autres caractères comme des espaces, cela marchera sans doute. Cependant, il n'est écrit nulle part dans le manuel que ça doit marcher, donc il n'est pas certain que cela marchera encore à l'avenir et je vous conseille de ne pas le faire.
+<latex>\TeX</latex> reconnaît les 52 caractères de l'alphabet (majuscules et minuscules sont distinctes) comme des lettres. Les caractères accentués, les chiffres ou des caractères comme le « ''@'' » ne sont pas des lettres. Il reste possible de demander à <latex>\TeX</latex> de changer sa notion de lettre : la question « [[2_composition:macros:makeatletter_et_makeatother|À quoi servent « \makeatletter » et « \makeatother » ?]] » présente le cas courant du « ''@'' ».
-Le deuxième élément à prendre en compte est le sens du nom. Même si je suis le premier à ne pas (toujours) suivre ce conseil, je vous encourage à ne pas le choisir trop court : votre source gagnera en lisibilité, et c'est sans doute plus important que d'économiser quelques frappes de touches. Par ailleurs, choisissez toujours un nom qui se rapporte au sens de la commande et pas à sa mise en forme (par exemple, ''\lebesgue'' pour la mesure de Lebesgue, indépendamment du fait que vous la notiez 'lambda'' ou autre chose).
+Pour les noms d'environnements, c'est plus simple : les caractères autorisés sont les lettres et le caractère « ''*'' » et ce, quelle que soit la longueur. Vous pouvez essayer d'utiliser d'autres caractères comme des espaces et cela marchera sans doute. Cependant, il n'y a aucune garantie que cela marchera encore à l'avenir et il n'est donc pas conseillé de le faire.
+===== Le sens du nom =====
-//Archived copy:// https://web.archive.org/web/20170314080827/https://elzevir.fr/imj/latex/tips.html#names
+Le deuxième élément à prendre en compte est le sens du nom. Cette recommandation est assez générale dans le monde informatique. Il faut qu'il soit compréhensible, quitte à ce qu'il soit un peu long : votre source gagnera en lisibilité, ce qui sans doute plus important que d'économiser quelques frappes de touches. Par ailleurs, choisissez toujours un nom qui se rapporte au sens de la commande et pas à sa mise en forme (par exemple, ''\lebesgue'' pour la mesure de Lebesgue, indépendamment du fait que vous la notiez ''lambda'' ou autre chose).
+-----
+//Source:// https://web.archive.org/web/20170314080827/https://elzevir.fr/imj/latex/tips.html#names
+{{htmlmetatags>metatag-keywords=(LaTeX,commande,environnement,lettre,nom)
+metatag-og:title=(Comment bien nommer ses commandes et environnements)
+metatag-og:site_name=(FAQ LaTeX francophone)
+}}