A lLIRE : L'indentation des sources

Question

Salut tout le monde !

J'ai remarqu&#233; que beaucoup de sources post&#233;s sont mal ou pas indent&#233;es, pensant que c'est parce que les auteurs ne savent pas comment indenter et non parce qu'ils n'en ont pas le courage, je vous propose quelques r&#232;gles (&#224; vous de voire si &#231;a vous va).

- Chaque boucle, bloc de condition, et tout autre bloc finissant par 'End ...' doit &#234;tre indent&#233; de la maniere suivante :
    Debut
        instructions
        instructions
    End Debut
- Ceci est valable pour les proc&#233;dures.
- Les ouvertures/fermetures de fichier peuvent &#234;tre indent&#233;s de la m&#234;me fa&#231;on.
- Une ligne de code ne doit &#234;tre d&#233;cal&#233;e que dans ces cas.
- La mise en &#233;vidence d'une ligne de code ne doit pas se faire par l'indentation.
- Les sauts de ligne ne remplaces pas l'indentation.
- Les sauts de lignes sont le plus souvent inutiles, preferez leurs une ligne de commentaire.
- Chaque proc&#233;dure doit &#234;tre s&#233;par&#233;e de la suivante par une ligne vide.
- Si un commentaire s'applique &#224; l'ensemble d'une proc&#233;dure, il doit se trouver AVANT la d&#233;claration de celle ci et n'empeche pas la pr&#233;sence de la ligne vide de s&#233;paration.
- Il est souvent plus lisible de s&#233;parer les 'If Then' sans 'End If' en 2 lignes &#224; l'aide du caractere de continuit&#233; :
    If Machin Then Truc
    Suite du, code
'deviens    
    If Machin Then _
        Truc
    Suite du,  code
-Les commentaires peuvent ne pas suivre l'indentation.

Voila pour le moment, merci.
[;)] Flachy Joe [;)]

crenaud76 · Answer

Ajoutons a cela l'indentation du Select Case, de cette facon :

Select Case truc
  Case Machin
    une action
    une autre action
  Case Machin2
    Encore une autre action
    ...
End Select

De plus, personnellement, je n'indente pas les ligne de déclaration de variable, que je place toujours en tete de procédure (en VB6 du moins, car en .NET, cela peut avoir un intéret de les déclarer juste au moment de s'en servir)

ScSami · Answer

J'ai un peu la m&#234;me r&#233;serve mais pas pour les m&#234;mes raisons...

Ce poste m'an&#232;ne &#224; vous rappeler que la MSDN recel des conventions de codage (du moins pour celle du VB6). C'&#233;tait juste pour l'info.

Enjoy 

<hr size="2" width="100%">
( Si une r&#233;ponse vous convient, cliquez sur le bouton "R&#233;ponse accept&#233;e". )

Flachy Joe · Answer

Pas d'acord avec toi [auteurdetail.aspx?ID=143123 crenaud76] l'indentation du 'select ' de cette maniere n'a aucune raison d'&#234;tre : les 'case' font parti de la commande et devrai donc &#234;tre align&#233;s avec le 'select'. De plus cette indentation n'apporte rien &#224; la lisibilit&#233; du code, on trouve aussi facilement le 'End Select' dans les deux cas.
Pas d'accord non plus pour ne pas indenter les d&#233;clarations de variables, elle font parti de la procedure et pas de sa d&#233;claration.

Pour le 'if then' en une ligne, vous &#234;tes en tout cas d'accord que c'est indigeste :)

Vous pouvez oublier le point
"- Les sauts de lignes sont le plus souvent inutiles, preferez leurs une ligne de commentaire."
car ils sont en fait indispensable pour s&#233;parrer diff&#233;rentes actions dans une m&#234;me proc&#233;dure.

Enfin, je conseil d'aligner les Exit Sub et autres Exit Function, sur la d&#233;claration de la procedure si cet exit &#224; lieu en premiere indentation, cad. pas dans une boucle ou une condition. Par expl :

Private sub form_load()
    On Error goto fin

    'premiere action
    machin
    truc
    bidule

    '2d action
    Select Case truc
    Case machin
            Youpla
            Exit Sub
    Case bidule
            Zouinzouin
    End Select
    Encore quelque, chose
Exit Sub

fin:
    MsgBox "Erreur"
End Sub

[;)] Flachy Joe [;)]