Commentaires et auto-documentation
Commentaires
Tout ce qui se trouve après le symbole % sera considéré comme un commentaire. Il sera donc ignoré lors de l'exécution du script.
En pratique, un commentaire peut servir à apporter des informations permettant une meilleure compréhension des lignes de commandes pour soi, ou pour ses collègues.
On peut aussi mettre en commentaire une ligne de commandes que l'on souhaite ignorer dans l'exécution, mais que l'on veut garder pour mémoire.
Exemple :
% ligne de commentaires a= 3 % commentaire après une commande % a= 2 % commande mise en commentaire, pour l'ignorer
Complément :
Si l'on souhaite mettre en commentaire tout un bloc de programme, on peut encadrer ce bloc par les symboles %{ et %}
Auto-documentation de scripts ou de fonctions
Il est également possible d'auto-documenter ses fichiers de commandes.
Pour cela, il suffit de mettre une série de lignes de commentaires ininterrompues au début du fichier de commandes, avant toute autre commande.
Ces lignes de commentaires s'afficheront à l'appel de la commande help, c'est ainsi que fonctionne l'aide en ligne pour toutes les fonctions prédéfinies de MATLAB.
Exemple :
Si l'on reprend l'exemple du script scriptDemo.m, présenté précédemment, on y a défini des commentaires comme auto-documentation de ce script. On peut donc appeler cette aide par la commande help :
>> help scriptDemo scriptDemo.m Fabien Baillon et Jean-Louis Dirion - Nov.2014 Ceci est un petit script de démonstration qui trace la courbe y = log(2)*x*sin(2x)