Marquez vos commentaires, une fonctionnalité par des développeurs pour des développeurs

Les commentaires sont essentiels dans la vie d’un développeur. Lorsque nous travaillons sur une nouvelle fonctionnalité, nous ajoutons souvent des commentaires qui sont des rappels. Par exemple :

• pour valider une partie du code avec un collègue,
• de refactoriser une fonction,
• pour corriger du code qui ralentit les performances,
• pour découper une méthode ou une classe en sections,
• pour préparer le squelette d’une classe et ajouter un commentaire à faire à l’intérieur de chaque fonction.

Même si vous écrivez du code 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 ?

4D v19 R4 fait passer les commentaires à un tout autre niveau grâce aux balises de commentaires qui vous permettent de mieux organiser vos commentaires.

Trois nouvelles balises sont à votre disposition :

• MARK
• TODO
• FIXME

Dans ce précédent billet de blog, nous vous avons montré une liste dans l’éditeur de code, vous permettant de naviguer facilement dans votre classe. Les commentaires précédés de ces trois balises sont également affichés dans cette liste.

Vous pouvez les utiliser au sein de vos classes ou méthodes.

Comment les utiliser

La balise MARK vous permet de diviser votre code en sections. Vous pouvez l’écrire de trois manières différentes. Les deux autres balises TODO et FIXME s’écrivent de la même manière. L’avantage est qu’elles ont des icônes différentes dans la liste, ce qui vous permet d’organiser votre code pour prioriser vos actions futures.

Voici un exemple avec une classe ORDA :

Les fonctions et les balises de commentaires sont affichées dans leur ordre d’apparition à l’intérieur de la classe et de la méthode. Si vous préférez, vous pouvez afficher les fonctions et les balises de commentaire d’une classe dans l’ordre alphabétique en maintenant Cmd sur macOS ou Alt sur Windows avant de déployer le menu.

Et maintenant ?

Prêt à améliorer votre jeu de codage avec cette nouvelle fonctionnalité ? Dites-nous ce que vous pensez de cette nouvelle possibilité d’organiser votre code et de naviguer dans vos classes ou méthodes. Nous vous attendons dans le forum.