Ajouter des commentaires au code

Lorsque vous écrivez du code, une bonne pratique consiste à ajouter des commentaires pour le décrire. Les commentaires permettent aux autres utilisateurs de comprendre votre code ou bien de vous rafraîchir la mémoire lorsque vous y revenez après un certain temps. Pendant le développement et le test du code, vous pouvez également utiliser des commentaires pour ignorer le code que vous n’avez pas besoin d’exécuter.

Dans le Live Editor, vous pouvez insérer des lignes de texte avant et après le code pour décrire ce dernier ou un processus. Les lignes de texte offrent une plus grande flexibilité avec notamment des options de mise en forme standard et l’insertion d’images, de liens hypertexte et d’équations. Pour plus d’informations, consultez Create Live Scripts in the Live Editor.

Ajouter des commentaires

Pour ajouter des commentaires au code MATLAB®, utilisez le symbole pourcentage (%). Les lignes de commentaire peuvent figurer n’importe où dans un fichier de code et vous pouvez ajouter des commentaires à la fin d’une ligne de code.

Par exemple :

% Add up all the vector elements.
y = sum(x)           % Use the sum function.

Mettre en commentaire du code

Pour mettre en commentaire plusieurs lignes de code, utilisez les opérateurs de bloc de commentaire %{ et %}. Les opérateurs %{ et %} doivent figurer seuls sur la ligne qui précède et la ligne qui suit le bloc de texte d’aide. N’insérez aucun autre texte sur ces lignes.

Par exemple :

a = magic(3);
%{
sum(a)
diag(a)
sum(diag(a))
%}
sum(diag(fliplr(a)))

Pour mettre en commentaire une sélection, sélectionnez les lignes de code, accédez à l’onglet Editor ou Live Editor puis dans la section Code, cliquez sur bouton de commentaire . Vous pouvez également appuyer sur Ctrl+R. Pour décommenter les lignes de code sélectionnées, cliquez sur le bouton de suppression de commentaire  ou appuyez sur Ctrl+Maj+R. Sur les systèmes macOS, utilisez Command+/ pour mettre en commentaire et Command+Option+/ pour décommenter. Sur les systèmes Linux®, utilisez Ctrl+/ pour mettre en commentaire et Ctrl+Maj+/ pour décommenter.

Pour mettre en commentaire une partie d’une instruction qui s’étend sur plusieurs lignes, utilisez des points de suspension (...) au lieu d’un symbole pourcentage. Par exemple :

header = ['Last Name, ',      ...
          'First Name, ',     ...
      ... 'Middle Initial, ', ...
          'Title']

Renvoyer les commentaires à la ligne

Par défaut, lorsque vous saisissez des commentaires dans l’éditeur et dans le Live Editor, le texte est renvoyé à la ligne dès qu’il atteint une largeur de colonne de 75. L’éditeur et le Live Editor ne renvoient pas les commentaires à la ligne dans les cas suivants :

  • Titres de section (commentaires commençant par %%)

  • Texte contigu long, comme les URL

  • Éléments de liste à puces (texte commençant par * ou #) sur la ligne précédente

Pour modifier l’emplacement où le texte des commentaires est renvoyé à la ligne ou pour désactiver le retour à la ligne automatique des commentaires, accédez à l’onglet Home et dans la section Environment, cliquez sur Settings. SélectionnezMATLAB > Editor/Debugger > MATLAB Languageet ajustez les paramètres Comment formatting.

Avant R2025a : sélectionnezMATLAB > Editor/Debugger > Languageà la place.

Pour renvoyer automatiquement à la ligne un commentaire existant qui dépasse la largeur de colonne actuelle, accédez à l’onglet Editor ou Live Editor puis dans la section Code, cliquez sur le bouton de retour à la ligne des commentaires . Supposons par exemple qu’une ligne de commentaire contienne le long texte suivant.

% This is a code file that has a comment that is a little more than 75 columns wide.
disp('Hello, world')
Placez le curseur sur la ligne en question, accédez à l’onglet Editor ou Live Editor puis dans la section Code, cliquez sur le bouton de retour à la ligne des commentaires . Le commentaire est renvoyé à la ligne suivante :
% This is a code file that has a comment that is a little more than 75
% columns wide.
disp('Hello, world')

Vérifier l’orthographe des commentaires

Vous pouvez vérifier si les commentaires contiennent des fautes d’orthographe. Pour activer la vérification orthographique, accédez à l’onglet View et cliquez sur le bouton Spelling pour l’activer. Les mots potentiellement mal orthographiés sont soulignés en bleu. Pour résoudre le problème, cliquez sur le mot et sélectionnez l’une des corrections suggérées. Vous pouvez également choisir d’ignorer le problème ou d’ajouter le mot signalé à votre dictionnaire local. Pour parcourir les problèmes avec le clavier, utilisez Alt+F7 et Alt+Maj+F7.

La vérification orthographique est supportée en anglais américain pour les fichiers de code et de live code MATLAB (.m et .mlx). Pour supprimer des mots de votre dictionnaire local, accédez à votre dossier de paramètres MATLAB (le dossier qui est renvoyé lorsque vous exécutez prefdir) et modifiez le fichier dict/en_US_userDictionary.tdi.

Voir aussi

Rubriques

Sites web externes