Comment ajouter des commentaires dans un fichier batch ou CMD

Un fichier batch ou CMD est un fichier texte qui contient une série de commandes qui peuvent être exécutées par le système d’exploitation Windows.

Les fichiers batch, également connus sous le nom de scripts CMD, sont un outil essentiel dans le monde du développement de logiciels. Les fichiers batch peuvent être utilisés pour effectuer diverses tâches, telles que l’exécution de programmes, la copie de fichiers ou la modification des paramètres système. Les fichiers batch ont généralement une extension .bat ou .cmd.

L’une des choses importantes dans la création d’un fichier batch est l’ajout de commentaires. Un commentaire est une ligne de texte qui n’est pas exécutée par le système d’exploitation, mais sert uniquement de note ou d’explication pour le créateur ou le lecteur du fichier de commandes.

Les commentaires peuvent être utilisés pour expliquer ce que fait une ligne de code ou pour documenter la fonction d’un fichier batch. En outre, les commentaires peuvent également vous aider à comprendre l’objectif et la logique des fichiers batch, ainsi qu’à faciliter la modification ou la réparation des fichiers batch à l’avenir.

Comment ajouter un commentaire

Dans le langage batch (.cmd), il existe trois façons courantes de commenter ou de désactiver le code à l’aide des marques  « REM »,  « :: » et « %==% ». Chaque méthode a des utilisations et un caractère unique qui doivent être compris pour être utilisés efficacement dans le développement de fichiers batch.

1] Utilisation de la marque « REM »

 « REM » signifie « remarque » et est une commande interne trouvée dans l’invite de commande du processeur de commandes Windows, qui permet d’inclure des commentaires dans les programmes batch.

Un commentaire est une ligne de texte qui n’est pas exécutée par le système d’exploitation, mais sert uniquement de note ou d’explication pour le créateur ou le lecteur du programme de traitement par lots. Les commentaires peuvent vous aider à comprendre l’objectif et la logique d’un programme de traitement par lots, ainsi qu’à faciliter la modification ou l’amélioration du programme de traitement par lots à l’avenir.

Les commentaires sont essentiels pour maintenir la lisibilité et la compréhension de votre code. Vous pouvez commenter différentes parties d’un fichier batch en utilisant la  marque « REM », comme dans l’exemple ci-dessous :

REM Ceci est un commentaire Les commentaires 
REM Ne seront pas exécutés par le système d'exploitation

Vous pouvez également utiliser les marques REM pour désactiver temporairement une commande sans la supprimer du programme batch. Exemple:

rem del C:\Windows\System32\file.txt

La commande ci-dessus doit supprimer le fichier nommé file.txt du dossier C:WindowsSystem32, mais comme elle commence par une marque de rupture, elle ne sera pas exécutée. Ceci est utile si vous souhaitez tester ou déboguer votre programme de traitement par lots sans modifier les résultats.

2] Utilisation du signe « :: »

 « :: » est une alternative plus courte à l’ajout de commentaires au code. Cependant, cela ne fonctionne que lorsqu’il est placé au début de la ligne. Bien qu’il ne s’agisse pas d’une commande officielle, il est couramment utilisé et plus esthétique dans le code.

:: Ceci est aussi un commentaire

L’avantage d’utiliser les deux-points est que vous n’avez pas besoin d’ajouter des espaces après eux, de sorte que vos commentaires peuvent être plus courts et plus nets. Cependant, l’inconvénient de l’utilisation de deux-points est que vous ne pouvez pas utiliser de caractères spéciaux tels que &, |, <, > ou ^ dans vos commentaires, car ces caractères ont des fonctions spéciales dans la syntaxe du programme batch.

3] Utilisation du signe « %==% »

%= =% est le moyen le plus flexible d’ajouter des commentaires. Vous pouvez utiliser cette méthode pour ajouter des commentaires à des lignes de code, à des paramètres de commande ou à des variables.

Par exemple, le code suivant ajoutera le  commentaire « Ceci est un commentaire pour  la ligne de code » à la première ligne de code :

set "var=3"  %= Ceci est un commentaire sur la même ligne =%

 « %==% » est un moyen moins courant de désactiver des parties de code. Cela vous permet de désactiver rapidement plusieurs lignes de code et de les réactiver facilement. Cependant, il peut ne pas être aussi commun que d’autres options et est moins familier à de nombreux développeurs.

La différence entre  « REM »,  « :: » et « %==% »

Voici un tableau résumant les différences entre REM, ::, et %==% :

•  « REM » est la commande officielle pour les commentaires dans les fichiers batch.
•  « :: » est une alternative plus courte, mais elle ne fonctionne qu’au début de la ligne.
•  « %===% » est un moyen moins courant de désactiver rapidement le code.

En général, REM est le moyen le plus courant et le plus compatible d’ajouter des commentaires à un fichier batch. :: est un moyen plus court et plus efficace, mais il n’est pas compatible avec toutes les versions de CMD. %= =% est le moyen le plus flexible, mais il n’est disponible que sur Windows 10 et supérieur.

Quand utiliser une méthode particulière ?

• Utilisez « REM » pour des commentaires et des explications clairs qui nécessitent une présentation officielle.
• Utilisez « :: » pour de courts commentaires qui clarifient le code au début de la ligne.
• Utilisez « %===% » pour désactiver les sections de code plus longues qui doivent être temporairement désactivées.

Conclusion

En fin de compte, votre choix entre  « REM »,  « :: » et « %==% » dépend de vos préférences personnelles et des exigences du projet.  « REM » est le choix officiel pour les commentaires, « :: »  est une option plus concise couramment utilisée au début d’une ligne, et « %==% » est un moyen moins courant de désactiver le code. Comprendre les différences et utiliser la méthode qui convient le mieux à votre style d’écriture et à vos besoins de développement