Blog

Eclipse Photon – Code Mining

Eclipse Photon intègre une nouvelle API nommée Code Mining pour améliorer la productivité lors de l’écriture de code.

Cet article fait partie d’une série composée de :

 

Le Code Mining permet d’ajouter du contenu (texte, icônes, …) dans du code source afin de fournir des informations contextuelles aux développeurs. Ce type de fonctionnalité est déjà présent dans d’autres IDE ou éditeurs de texte comme CodeLens de certains outils Microsoft.

Par exemple, pour afficher :

  • Le type et le nom des paramètres,
  • Le nombre de références/implémentation
  • La valeur d’une variable en debug
  • L’affichage d’un état

Le but du code Mining est d’aider les développeurs à mieux comprendre le code et/ou à interagir avec celui-ci. Il est aussi possible d’ajouter des actions sur un clic.

Le contenu peut prendre deux formes :

  • LineHeader : afficher sur la ligne du dessus
  • LineContent : afficher dans le code

Le support du Code Mining est intégré dans le SDK d’Eclipse Photon au travers d’une API.

 

L’utilisation du Code Mining dans le JDT

L’exploitation du Code Mining dans le JDT d’Eclipse Photon requiert un plug in tiers, développé par Angela ZERR, à installer en utilisant l’url :

http://oss.opensagres.fr/jdt-codemining/snapshot/

L’installation du plugin se fait comme pour tout autre plugin sous Eclipse.

Eclipse_photon_code_mining_001

Eclipse_photon_code_mining_003

Par défaut, aucune option n’est activée :

Eclipse_photon_code_mining_005

Il suffit de sélectionner celles que l’on souhaite activer. Certaines options sont pratiques.

 

Les fonctionnalités proposées par le plugin

Le plugin propose plusieurs fonctionnalités mises en oeuvre en utilisant l’API Code Mining.

 

L’affichage du type et du nom des paramètres

Eclipse_photon_code_mining_008

 

L’exécution des tests unitaires

Il est possible de demander l’exécution d’une classe ou d’une méthode test simplement en cliquant sur « Run » ou « Debug ».

Eclipse_photon_code_mining_009

L’icône affichée au début représente le statut de l’exécution du test

Eclipse_photon_code_mining_011

 

L’affichage du nombre de références

Eclipse_photon_code_mining_013

 

L’affichage du type d’une variable locale définie avec l’instruction var en Java 10

Eclipse_photon_code_mining_015

 

La possibilité d’exécuter une méthode main()

Eclipse_photon_code_mining_017

 

L’affichage de la fin d’un bloc d’instructions

Il est possible de cliquer dessus pour se déplacer au début de l’instruction.

Eclipse_photon_code_mining_019

 

Conclusion

Parfois perturbant au début, car il y a des informations supplémentaires affichées dans le code source, le Code Mining s’avère pratique à l’usage. C’est une fonctionnalité qui était manquante dans Eclipse et qui est maintenant intégrée dans Eclipse Photon.

Le prochain article de cette série détaille les nouveautés du plugin de développement Java, le JDT.
 

Jean-Michel Doudoux

Written by

CTO OXiane

  • Laurent Martelli

    L’auteur du plugin semble s’appeler Angelo et non Angela.