L’ajout d’un bloc de commentaires au début d’une méthode est utile pour ajouter une note sur ce que fait la méthode, ainsi qu’une liste de paramètres d’entrée/sortie. Et le fait de disposer de quelques lignes de texte lisible par l’homme au sein d’une section de code complexe peut s’avérer pratique pour vous aider, vous et les autres, à vous souvenir de l’objectif de cette section de code particulière. À partir de 4D v18, votre expérience de programmation est améliorée grâce à l’ajout de blocs de commentaires !
Les commentaires sont des textes (notes, descriptions, rappels, etc.) dans le code source, désignés par des caractères spéciaux afin d’être ignorés par le compilateur pendant l’exécution du code. Les commentaires peuvent se trouver sur une seule ligne ou sur plusieurs lignes. Maintenant, au lieu d’avoir de nombreuses lignes préfixées par //, vous pouvez simplement utiliser /* au début d’un commentaire et */ à la fin pour commenter un bloc entier. Vous pouvez également les réduire et les développer ! Et ce n’est pas tout, vous pouvez même ajouter des commentaires à n’importe quelle partie d’une ligne, même à l’intérieur d’une condition if ou d’une boucle :
Pourquoi les commentaires sont importants
- Dans une équipe de plusieurs développeurs travaillant sur le même projet, un code bien commenté est utile aux autres personnes travaillant sur le projet afin qu’elles puissent mieux comprendre le code et faciliter le processus de révision/débogage du code.
- Nous sommes humains et il est tout à fait normal d’oublier des choses. Si vous consultez ou modifiez votre code ultérieurement, les commentaires peuvent vous aider à vous souvenir de la logique utilisée lors de l’écriture de ce code. Même si vous écrivez un code très simple, essayez de le lire des mois ou des années plus tard. Vous semblera-t-il toujours aussi simple, ou regretterez-vous de ne pas avoir ajouté de commentaires ?