Script Batch - Commentaires

Bonjour, futurs programmeurs ! Aujourd'hui, nous allons plonger dans un aspect essentiel du scripting batch : les commentaires. En tant que votre enseignant informatique de quartier, je suis excité de vous guider à travers ce sujet. Les commentaires peuvent sembler simples, mais ils sont des outils incroyablement puissants qui peuvent rendre votre code plus lisible et plus facile à entretenir. Alors, c'est parti !

Qu'est-ce que les commentaires ?

Avant de rentrer dans les détails, parlons de ce qu'est un commentaire et pourquoi ils sont importants. Les commentaires sont des lignes dans votre code qui sont ignorées par l'ordinateur lorsque le script s'exécute. Ils sont comme de petites notes que vous laissez pour vous-même ou pour d'autres programmeurs qui pourraient lire votre code plus tard.

Imaginez que vous écrivez une recette pour un ami. Vous pourriez ajouter de petites notes comme "L'ingrédient secret de Maman" ou "Laissez-le mijoter pendant exactement 5 minutes - croyez-moi !" Ces notes aident votre ami à comprendre votre pensée et à suivre la recette plus facilement. Les commentaires dans la programmation fonctionnent de la même manière !

Commentaires avec l'instruction Rem

Dans le scripting batch, une façon de créer des commentaires est d'utiliser l'instruction REM. REM signifie "remark" ou "remember" (remarque ou se souvenir), et il indique à l'ordinateur d'ignorer tout ce qui suit sur cette ligne.

Regardons quelques exemples :

@echo off
REM Questo è uno script batch semplice per salutare l'utente
echo Hello, World!
REM La ligne suivante affichera la date actuelle
date /t

Dans ce script, nous avons deux commentaires :

1. REM Questo è uno script batch semplice per salutare l'utente
2. REM La ligne suivante affichera la date actuelle

Ces lignes ne seront pas exécutées lorsque vous exécutez le script. Ils sont là pour vous aider (ou quelqu'un d'autre) à comprendre ce que fait le script.

Voici un autre exemple :

@echo off
REM Ce script calcule la somme de deux nombres
set /a num1=5
set /a num2=10
REM Ajouter num1 et num2
set /a sum=%num1%+%num2%
echo La somme est %sum%

Dans ce script, nous utilisons des commentaires pour expliquer ce que fait chaque partie du script. Cela est particulièrement utile lorsque vos scripts deviennent plus complexes.

Conseil Pro :

Je dis toujours à mes élèves d'imaginer qu'ils expliquent leur code à leur grand-mère. Si vous pouvez écrire des commentaires qui ont du sens pour quelqu'un qui n'a jamais vu de code auparavant, vous avez fait le bon choix !

Commentaires avec l'instruction ::

Maintenant, regardons une autre façon de créer des commentaires dans les scripts batch : l'instruction ::. Cette méthode est un peu une astuce car :: est en réalité un étiquette qui ne fait rien. Mais parce qu'il ressemble à un commentaire et qu'il agit comme un commentaire, de nombreux programmeurs l'utilisent comme tel.

Voici un exemple :

@echo off
:: Ce script montre l'utilisation de :: pour les commentaires
echo This is a demo script
:: La ligne suivante mettra en pause le script
pause

Dans ce script, les deux lignes commençant par :: sont des commentaires. Ils ne seront pas exécutés lorsque le script est lancé.

Un avantage d'utiliser :: pour les commentaires est qu'il est légèrement plus rapide que REM car l'ordinateur n'a pas besoin de traiter l'instruction REM. Cependant, cette différence est généralement négligeable dans les scripts de petite taille.

Avertissement :

Bien que :: fonctionne bien pour les commentaires dans la plupart des cas, il peut parfois causer des problèmes si vous l'utilisez au début d'un bloc de code (comme à l'intérieur d'une instruction if). Cela peut parfois entraîner un comportement inattendu. Pour cette raison, il est généralement plus sûr d'utiliser REM pour les commentaires à l'intérieur des blocs de code.

Voici un exemple de où :: pourrait causer des problèmes :

@echo off
if 1==1 (
:: Ce commentaire pourrait causer des problèmes
echo This is inside the if block
)

Dans ce cas, il est préférable d'utiliser REM :

@echo off
if 1==1 (
REM Ce commentaire est sûr à utiliser ici
echo This is inside the if block
)

Comparaison de REM et ::

Résumons les différences entre REM et :: dans un tableau pratique :

Fonctionnalité	REM	::
Mot complet	Oui (REMark)	Non
Vitesse	Légèrement plus lent	Légèrement plus rapide
Sécurité dans les blocs de code	Oui	Non
Identifié clairement comme commentaire	Oui	Non (ressemble à une étiquette)

Meilleures Pratiques pour l'utilisation des commentaires

Maintenant que vous savez comment créer des commentaires, parlons de quelques meilleures pratiques :

1. Soyez clair et concis : Écrivez des commentaires qui expliquent pourquoi vous faites quelque chose, pas seulement ce que vous faites.
2. Mettez à jour les commentaires : Si vous modifiez votre code, assurez-vous de mettre à jour les commentaires également !
3. Ne sur-commentez pas : Vous n'avez pas besoin de commenter chaque ligne. Concentrez-vous sur les parties qui pourraient être déroutantes.
4. Utilisez les commentaires pour le débogage : Temporairement commenter des lignes de code peut vous aider à trouver des bugs.

Voici un exemple de bon commenting :

@echo off
REM Ce script calcule l'âge d'un utilisateur

REM Demandez à l'utilisateur de saisir son année de naissance
set /p birth_year=Entrez votre année de naissance :

REM Obtenez l'année actuelle
for /f "tokens=2 delims==" %%I in ('wmic os get localdatetime /value') do set datetime=%%I
set current_year=%datetime:~0,4%

REM Calculez l'âge
set /a age=%current_year%-%birth_year%

REM Affichez le résultat
echo Vous avez environ %age% ans.

Dans ce script, nous utilisons des commentaires pour expliquer chaque section du code. Cela rend plus facile pour quelqu'un (y compris vous à l'avenir) de comprendre ce que fait le script et comment il fonctionne.

Conclusion

Les commentaires sont un outil puissant dans votre boîte à outils de programmation. Ils aident à rendre votre code plus lisible, plus facile à entretenir et plus compréhensible. Que vous choisissiez d'utiliser REM ou ::, l'important est que vous ajoutez de la clarté à votre code.

N'oubliez pas, écrire de bons commentaires est une compétence qui se développe avec le temps. Alors que vous continuez votre parcours en programmation, vous deviendrez meilleur pour savoir quoi commenter et comment expliquer votre code efficacement.

Bonne programmation, et n'oubliez pas de laisser ces notes utiles dans vos scripts !

Credits: Image by storyset