Discussion :

[weejungle]

Salut à tous,

je viens ici chercher l'inspiration...

Voilà je me demande si vous auriez de bons conseils pour la forme à utiliser pour la description d'une macro Excel.

Pour que se soit lisible, clair et pourquoi pas joli !

Merci d'avance

[Singular]

Ben, pour commencer, tu peux mettre la description en commentaire sous la ligne Sub ou Function.

Dans ce commentaire, tu dois décrire ce que fait ta macro en nommant les paramètres utilisés et, en terminant, tu dois indiquer le type de valeur renvoyée par une Function ainsi que chaque valeur dépendante des conditions.

Et, pourquoi pas, mets aussi la date de création et de dernière modification à la fin ainsi que le nom du programmeur dans chaque cas.

Un peu d'aération dans le texte aide aussi...

Petit exemple de fonction presque inutile:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
 
Function EstLeChiffreEnChaine(ByRef ChiffreChaine As String, ByVal ChiffreNum As Integer) As Boolean
' Cette fonction compare la chaine ChiffreChaine avec l'entier ChiffreNum.
'
' Elle renvoit un valeur de type Boolean : VRAI (True) si la chaine représente
'   la valeur du chiffre, et FAUX (False) dans le cas inverse.
'
' Date de création :                21 novembre 2007    par Singular
' Date de dernière modification :   22 novembre 2007    par Singular
 
    EstLeChiffreEnChaine = IIf(CInt(Trim(ChiffreChaine)) = ChiffreNum, True, False)
End Function

[laloune]

Un peu d'aération dans le texte aide aussi..

je dirais même plus, dupond, que c'est complètement indispensable, surtout pour les macros super longues... Le plus critique étant les tabulations lorsqu'on a une condition, une boucle, un with...

et commenter, pour les suivants :-)

mais bon ca n'est que l'avis d'un humble "codeur" dont ce n'est pas la formation...

[Singular]

Envoyé par laloune, ci-haut:
Le plus critique étant les tabulations lorsqu'on a une condition, une boucle, un with...

Je n'avais pris en compte que la description de la macro mais, oui, les commentaires et la rigueur des indentations sont tout aussi importants pour la compréhension du code.

J'ai aussi pris comme habitude de mettre en commentaire les Ifs, Fors, Dos, et Whiles à la suite des
End Ifs, Nexts, Loops, et Wends auxquels ils se rapportent dans les macros complexes...

Exemple:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
Do While 1 = 1
  blablabla
  taratata
  ... longue séquence de code
Loop ' Do While 1 = 1

...histoire de ne pas me casser la tête trop longtemps en cas d'erreur de logique.

NB: D'une certaine manière, cette discussion devrait être déplacée dans une catégorie plus générale sur le guide du parfait petit programmeur...
Dans Général Développement/Langages en général, par exemple.

[laloune]

ah bien vu l'indien ! tout simple mais puissant... et terriblement utile

thx verre e-mouche

[gedechp]

bonjour

j'aime bien les # pour les en tetes de macro et les * pour les en tetes de chapitres
d'autres car peuvent rendre la lecture du code agreable

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Sub detest()
'
' ###################################################
' detest Macro
' Macro enregistrée le 17/09/2004 par GERARD 
' Le but de ce programme est de deproteger des 12 feuilles du classeur 
' 
' ###################################################
'
' 
' *********************************************************
' déclaration des variables
' *********************************************************
'
'variable de formule
dim mavar as string
'
'

cordialement
GERARD