Le Mercredi 27 Avril 2005 19:27, Gontran a écrit :
> Pour les fonctions qui retourne une valeuur, j'indique également le type
> pour la valeur de retour dans le nom :
>
> iGetValue() retourne ainsi un nombre
> sGetURL() retourne une chaîne

Juste un petit complément pour dire qu'avec cette notation pour les variables 
et les fonctions, je me suis fait une macro sous Vim qui me permet de générer 
automatiquement un commentaire au dessus de la variable ou de la fonction. 
Par exemple, je place le curseur sur le nom de la fonction, je fais le 
contrôle de touches « \c », et ça me génère ceci :

/*
* iGetValue
*
* Description :
*
* Parameters :
*
* Returned value : integer -> 
*
*/
iGetValue () {
   ...
}

Ainsi, je n'ai plus qu'à compléter chaque champ du commentaire.

++
Gontran

Répondre à