Commentaires

Introduction

Comme la plupart des langages de programmation, MagiScript offre des possibilités de commentaires qui permettent aux développeurs d'annoter leur code avec des informations utiles sans affecter la fonctionnalité du code.

Commentaires sur une seule ligne

Les commentaires d'une seule ligne dans MagiScript sont similaires à ceux de JavaScript et sont désignés par les deux barres obliques (//). Tout ce qui est écrit après le // sur la même ligne sera considéré comme un commentaire et sera ignoré par l'interprète. Voici un exemple de commentaire sur une seule ligne :

// This is a single-line comment in MagiScript
let x = 10; // This will set x to 10.

Commentaires sur plusieurs lignes

MagiScript supporte également les commentaires multi-lignes, qui sont utiles lorsque vous souhaitez ajouter des commentaires qui s'étendent sur plusieurs lignes. Les commentaires multilignes commencent par /* et se termine par */. Voici un exemple de commentaire sur plusieurs lignes :

/*
This is a multi-line comment in MagiScript
It can span multiple lines
*/

Conseils pour rédiger de bons commentaires

De bons commentaires peuvent rendre votre code plus lisible et plus facile à comprendre, en particulier pour les autres développeurs qui travaillent avec le même code. Voici quelques conseils :

1. Soyez concis et allez droit au but. Les commentaires doivent fournir des informations utiles sans être trop verbeux.
2. Utilisez les commentaires pour expliquer l'objectif de votre code, et non ce qu'il fait. Le code doit être explicite et les commentaires doivent se concentrer sur l'explication de la raison d'être du code et du problème qu'il résout.
3. Utilisez des commentaires pour clarifier tout code complexe ou confus. Si une ligne ou une section particulière du code est difficile à comprendre, ajoutez un commentaire pour l'expliquer.
4. Évitez de commenter des choses évidentes. Les commentaires qui se contentent de répéter ce que fait le code ne sont pas utiles et peuvent être gênants.
5. Assurez-vous que vos commentaires sont à jour. Si vous modifiez votre code, mettez à jour les commentaires pour refléter ces changements.
6. Utilisez des noms de variables et de fonctions significatifs pour expliquer ce qu'ils signifient, de sorte que vous n'aurez pas besoin de commentaires.

En suivant ces conseils, vous pouvez écrire des commentaires qui faciliteront la lecture, la compréhension et la maintenance de votre code.

Conclusion

Les commentaires sont parfaits pour écrire des notes sur le code. Vous pouvez les utiliser pour comprendre ce que fait le code et aider le lecteur. N'en abusez pas, les commentaires qui n'apportent pas de nouvelles informations ne sont pas utiles.

Pour commencer

Bienvenue sur

Exécution de votre premier programme

Techniques de débogage

Exemples

Temps atomique

Pratique du temps

Révélations sur les Pi

Tambour atomique

Pile Atom

Atom Square

Niveau de l'atome

Atome THMPR

Mains de poker

Entrée/sortie

Boutons

Moteur à vibrations

LED RVB

PeekSmith

SB Watch

Clavier Bluetooth

Minuteries

Base de données

Système (exit, sleep, rand)

Objets (carte, heure)

Langue

Résumé

Commentaires

Déclarations de variables

Opérateurs

Flux de contrôle

Fonctions

Chiffres

Cordes

Tableaux

Objets

Uint8Array