Indenter son code : pourquoi et comment ?

I. Présentation

L'indentation du code est une bonne pratique de mise en forme du code source dans un script ou un programme, dans le but de le rendre plus lisible. C'est une recommandation pour tous les langages de scripting et de programmation, y compris avec le langage PowerShell.

Dans ce chapitre, nous allons évoquer plusieurs bonnes raisons d'indenter son code, puis, nous verrons comment procéder à l'aide de votre éditeur de code, que ce soit Windows PowerShell ISE ou Visual Studio Code.

II. Pourquoi indenter son code ?

Voici plusieurs arguments en faveur de l'indentation du code au sein d'un script PowerShell. En effet, le principe de l'indentation du code ne s'applique pas au contexte de l'administration en ligne de commande.

• Lisibilité : l'indentation aide à distinguer visuellement les blocs de code, comme les boucles et les structures conditionnelles. Cela rend le code plus facile à lire et à comprendre.

• Débogage : un code bien indenté peut aider à repérer des erreurs plus facilement, grâce au fait que le code semble plus aéré, mieux organisé. Par exemple, si une accolade n'est pas correctement alignée, cela peut indiquer qu'il manque une accolade correspondante ailleurs dans le code.

• Maintenance : un code bien organisé et structuré est plus facile à maintenir. Si vous devez éditer votre script dans plusieurs semaines ou plusieurs mois, ou si quelqu'un d'autre doit travailler sur votre code (un collègue, un contributeur, etc), il sera plus facile de reprendre la suite si le code est bien indenté.

Maintenant, nous allons voir comment vous pouvez indenter votre code.

III. Comment indenter son code ?

En PowerShell, l'indentation se fait généralement avec des tabulations, ou éventuellement avec des espaces. Il n'y a pas de règle stricte, mais l'important est de rester cohérent tout au long de votre code. La tabulation est plus pratique, car la touche associée sur le clavier permet de créer un "espace" important d'un simple appui.

Voici un exemple de quelques lignes de PowerShell, avec ou sans indentation, pour bien mettre en évidence l'intérêt de l'indentation :

Dans cet exemple, chaque niveau d'indentation est décalé d'une tabulation. La définition de la boucle Foreach, de la commande Get-ADGroupMember et de sa boucle Foreach-Object, puis des commandes intégrées dans cette seconde boucle, sont toutes clairement distinguables grâce à l'indentation.

En fin de compte, l'important est de choisir une méthode d'indentation qui fonctionne pour vous et de s'y tenir (notamment le choix entre la tabulation et l'espace). Personnellement, la tabulation me semble être plus efficace. L'important étant d'adopter l'indentation pour vous assurer que votre code est facile à lire et à maintenir, même s'il faut en complément respecter d'autres bonnes pratiques.