Commentaires
Les fonctions, comme les scripts, peuvent contenir des commentaires.
Comme une fonction est un bloc de commandes que l'on juge utile de mutualiser, a priori, on risque de ré-utiliser ce bloc fonctionnel. Il est donc important de commenter correctement une fonction, pour favoriser sa ré-utilisation, par soit-même ou par un autre utilisateur.
Définition :
Le symbole % précède toute chaîne de caractères que l'on souhaite mettre en commentaires. Ces commentaires ne sont pas pris en compte lors de l'exécution du script ou de la fonction.
Il est d'usage de commencer les fichiers de fonction par des lignes de commentaires. Ces commentaires servent à documenter la fonction, pour pouvoir en faciliter son ré-emploi, en indiquant qui a créé cette fonction, pour quoi faire, avec quels arguments d'entrée et quelles sorties possibles.
Le cas échéant, il peut être utile de préciser les méthodes utilisées, ou les restrictions d'usage. On peut même indiquer des exemples d'utilisation, si cela est nécessaire.
%% tribulle.m
% Fabien Baillon et Jean-Louis Dirion - Novembre 2014
%
% Cette fonction permet de trier un ensemble de valeurs.
%
% V est le vecteur de valeurs à trier
%
% ordre est un caractère :
% s'il vaut 'c', le tri sera par ordre croissant,
% s'il vaut 'd', le tri sera par ordre décroissant.
%
% La fonction renvoie comme sortie le vecteur trié.
%
% La méthode utilisée pour ordonner le vecteur V est le tri par bulle.
%
% --- USAGE ---
% par exemple :
% vecteurTrie = tribulle([2, 4, -2, 1], 'c');
% ------------
%
% -- HISTORIQUE --
% version 2, 15 Nov. 2014 : modification de tribulle
% pour utiliser une fonction anonyme permettant de definir une condition de tri
% selon la valeur de l'ordre choisie.
% ----------------
function V = tribulle(V,ordre)
continu = true;
% selon l'ordre choisi, on défini le test de tri par une fonction anonyme
switch ordre
case 'c'
condition = @(V,indice) V(indice) > V(indice+1);
case 'd'
condition = @(V,indice) V(indice) < V(indice+1);
end
% on continue le tri, tant qu'un parcours de V donne lieu au tri d'une valeur
while(continu)
continu = false;
for indice=1:length(V)-1
if(condition(V,indice))
% si la valeur du vecteur à l'indice testé et la suivante ne sont pas dans le bonne ordre,
% on les permute
tmp = V(indice);
V(indice) = V(indice+1);
V(indice+1) = tmp;
continu = true;
end
end
end
end
Rappel :
Ces premières lignes de commentaires sont celles qui apparaissent lorsque l'utilisateur cherche de l'aide avec la commande help.
De manière très générale, il est important de commenter le code que l'on écrit. Ces commentaires permettent d'expliciter les choix ou méthodes mis en œuvre.
Le symbole % peut aussi permettre de mettre en commentaire une ligne de code que l'on veut temporairement ignorer.
Complément :
Pour mettre en commentaire un bloc de lignes, il est possible de l'entourer par les symboles %{ et %}.
%{
x=0:0.05:1;
y=sin(x);
plot(x,y)
%}