Expressions régulières pour mettre en évidence les commentaires dans PyCharm

Les étudiants demandent souvent pourquoi les expressions régulières sont nécessaires. À première vue, leur utilité n’est peut-être pas évidente. En général, leur objectif est de travailler avec du texte : rechercher et remplacer.

Par exemple, j'ai eu besoin une fois de comparer les journaux de deux tests. Elles étaient potentiellement identiques, mais chaque ligne commençait par des horodatages différents.
En utilisant une expression régulière pour faire correspondre les horodatages, j'ai remplacé ces sous-chaînes par une chaîne vide dans Sublime (une fonctionnalité probablement disponible dans n'importe quel éditeur de texte). Ensuite, j'ai comparé les deux fichiers dans Meld, un outil pratique pour comparer les fichiers et les répertoires que j'utilise fréquemment.

PyCharm prend également en charge la recherche et le remplacement de texte par des expressions régulières.

Cependant, je vais aborder une autre fonctionnalité de PyCharm qui utilise des expressions régulières : la mise en évidence de commentaires spécifiques dans le code. L'exemple le plus courant est celui des commentaires TODO.

Mais comment PyCharm sait-il mettre en évidence ce texte dans une couleur spécifique ? Ces paramètres peuvent être personnalisés, et c’est ce que nous allons explorer.

Accédez au menu :
Fichier -> Paramètres... -> Éditeur -> À FAIRE

Ici, vous trouverez deux règles prédéfinies pour mettre en évidence les commentaires : TODO et FIXME. Essayez-le — FIXME utilise la même règle de surbrillance que TODO.
La règle elle-même est définie par l'expression régulière : btodob.*.

Ce motif correspond à :

1. Le mot todo comme un mot entier (en utilisant b pour désigner une limite de mot)
2. Suivi de n'importe quel nombre de caractères (.*).

Une limite de mot (b) est la limite entre un caractère w (lettres, chiffres ou traits de soulignement) et un caractère non-w.

Dans ce menu, vous pouvez ajouter vos propres règles. Par exemple, ajoutons une règle pour "Non implémenté".

Ici, vous pouvez configurer :

• Motif : une expression régulière pour correspondre au texte à surligner.
• Icône : une icône à afficher dans la fenêtre de l'outil TODO.
• Sensibilité à la casse : indique si la correspondance est sensible à la casse.
• Style par défaut : si cette case n'est pas cochée, vous pouvez personnaliser le style de surbrillance, sinon le style TODO par défaut sera appliqué.
• Options de style personnalisé :
  • Style de police (gras, italique)
  • Couleur du texte
  • Couleur de fond
  • Couleur de la bande d'erreur
  • Styles de décoration et leurs couleurs (souligné, souligné en gras, sous-agité, bordé, barré, ligne pointillée).

Voici ce que nous avons :

Et voici comment cela apparaît dans la fenêtre de l'outil TODO : vous pouvez voir l'icône personnalisée que nous avons sélectionnée et la couleur de la bordure est plus visible. Dans cette capture d'écran, j'ai également cliqué sur le bouton des filtres pour montrer qu'aucun filtre n'est encore appliqué.

Revenons aux paramètres TODO et ajoutons un filtre pour la règle "Non implémenté".

Maintenant, dans la fenêtre de l'outil TODO, un nouveau filtre "Non implémenté" apparaît dans la liste. Lorsque vous sélectionnez ce filtre, seuls les commentaires « Non implémenté » s'afficheront dans la fenêtre de l'outil TODO.

Il existe une option supplémentaire dans les paramètres de commentaire TODO que nous n'avons pas mentionnée : "Traiter le texte en retrait sur les lignes suivantes comme faisant partie de la même TODO".

Cette case à cocher s'applique à toutes les règles. Si la ligne suivant un commentaire TODO contient un commentaire en retrait, la même règle lui sera appliquée.

---

Comme vous pouvez le constater, il n’est pas nécessaire de créer des expressions régulières trop complexes : des expressions simples suffiront. Cependant, même dans ce contexte, ils peuvent faciliter votre travail.
Utilisez-vous souvent des expressions régulières ?

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!