Comment vérifier la syntaxe de mon code #

Les vérificateurs de syntaxe sont soit des extensions soit des programmes externes, qu’ils soient indépendants ou inclus dans des environnements intégrés de développement (IDE). Dans ce dernier cas, la vérification syntaxique peut se faire en même temps que l’on saisit le code (« en ligne »), ou par appel d’une option de menu.

1.  Vérificateurs internes à #

1.1.  L’extension syntonly#

Si vous travaillez sur un gros document et que vous souhaitez savoir rapidement si votre code est correct ou non, vous pouvez utiliser l’extension syntonly. Elle permet de compiler votre document sans produire de fichier de sortie, ce qui fait gagner du temps.

Ajoutez simplement ces deux lignes à votre préambule :

\usepackage{syntonly}
\syntaxonly
% suite ...

ne produira plus aucune page, mais il vérifiera que votre syntaxe est correcte et que votre document compile. Le log devrait dire quelque chose comme ça :

No pages of output.
Transcript written on mon_document.log.

Pour restaurer un fonctionnement normal, mettez juste la commande \syntaxonly en commentaire :

\usepackage{syntonly}
% \syntaxonly

À titre de test, nous avons compilé la documentation de la classe « memoir » avec et sans \syntaxonly sur un MacBook pro de 2018, dix fois :

\syntaxonly

Durée de la compilation

Sans

4,33s ± 0,06

Avec

1,92s ± 0,04

soit un gain d’un facteur supérieur à 2 pour un document de 567 pages.

1.2.  L’extension refcheck#

L’extension refcheck permet, elle, de vérifier les références d’un document. Il suffit de la charger :

\usepackage{refcheck}

Puis il faut compiler deux fois le document. L’extension signale alors les étiquettes inutiles, les équations non référencées, les références bibliographiques non appelées, et peut vous aider à maintenir votre document en affichant les noms des étiquettes \label dans la marge.

Il n’est pas influencé par les options final/draft. Il faudra donc bien penser à le retirer manuellement pour produire la version finale de votre document !

Important

Attention à charger refcheck après amslatex et hyperref, car il modifie certaines de leurs macros.

1.3.  L’extension nag#

L’extension nag n’est pas à proprement parler un vérificateur de syntaxe, mais elle vous prévient si vous utilisez des commandes, extensions ou classes considérées comme obsolètes.

2.  Vérificateurs externes à #

2.1.  Le programme lacheck#

Le programme lacheck est disponible avec la distribution (mode pour Emacs). Il est capable de vérifier la syntaxe et de détecter les erreurs les plus fréquentes.

2.2.  Le programme chktex#

Le programme chktex est capable de détecter des erreurs typographiques dans du code Il permet de s’affranchir de certaines constructions non intuitives. Des exécutables pour Unix, Amiga, MS-DOS et OS/2 sont disponibles. Le programme étant écrit en ANSI C, il devrait aussi fonctionner sur tous les Windows après recompilation.

Voici quelques exemples d’erreurs détectées :

  • vérification de l’absence d’espace ou assimilé après/avant une parenthèse ;

  • vérification de la cohérence du style ;

  • mise en garde en cas d’utilisation de primitives

  • gestion des \left et \right erronés ;

  • indication des espaces multiples qui ne sont pas équivalents à un seul ;

  • gestion de la ponctuation en mode mathématique ;

  • indication des espaces avant une note de bas de page ;

  • gestion des fichiers inclus ;

  • détection des blancs avant une référence au lieu de ~ ;

  • vérification des couples de parenthèses ;

  • gestion de l’espace après un passage en italique ;

  • …

Cet outil est configurable.

Sources