TP2 : Utilisation d`Eclipse et de Javadoc

MIT 1re année - 2011/12
Module PROG2
TP2 : Utilisation d’Eclipse et de Javadoc
Le but de ce TP est de vous initier à l’utilisation d’Eclipse, IDE de référence pour le
développement d’applications Java. Ce TP est réalisé pour la version Indigo d’Eclipse. Ensuite,
l’outil de documentation Javadoc vous est présenté rapidement.
1
Mise en route
Eclipse requiert que l’environnement d’exécution Java (JRE - Java Runtime Environment)
soit installé sur votre machine (on utilisera Java 1.6). Eclipse vient avec ses propres outils
de dévoloppment, dont un compilateur Java, mais dans des scénarios de développement plus
avancés, un JDK (Java Development Kit) complet peut être nécessaire. Notez que le JDK inclut
un JRE. Si Java n’est pas installé sur votre machine : Google est votre ami.
Installation d’Eclipse Pour installer Eclipse, téléchargez le package Eclipse IDE for Java Developers depuis http://www.eclipse.org/downloads et dézippez l’archive dans un répertoire
local de votre choix. De préférence, le chemin absolu menant jusque ce répertoire ne contiendra
pas de caractère espace (Eclipse est parfois taquin). Après désarchivage, Eclipse est prêt à être
utilisé : aucune autre procédure d’installation n’est requise.
Lancement d’Eclipse Pour démarrer Eclipse, lancer l’exécutable (eclipse.exe sous Microsoft Windows, ou eclipse sous Linux et Mac) du répertoire créé au paragraphe précédent. Le
système vous demande alors de configurer votre Workspace, l’endroit où vous stockerez tous
vos projets Java. Choisissez un répertoire et pressez OK. Eclipse démarre alors, et vous montre
l’onglet d’accueil. Vous pouvez le clore.
Configuration du compilateur Sélectionnez le menu Window → Preferences. Puis, dans
l’onglet Java, choisissez, pour le compilateur, un comportement compatible avec la version 6 de
Java (Compiler Compliance Level).
2
Premiers pas
Vous pouvez maintenant créer votre premier projet, qui sera un simple ”Hello World”.
Création de projet Pour cela, utilisez l’option New Project du menu File. Dans la boı̂te
de dialogue qui apparaı̂t, choisissez Java Project. Une fois créé, votre projet doit apparaı̂tre
dans la vue Package située sur la gauche de la fenêtre. Cliquez sur la flèche pour le parcourir :
il doit contenir la JRE System Library, ainsi qu’un répertoire de sources src. Sinon, créez
ce répertoire, en cliquant droit sur le nom de votre projet et en sélectionnant New Source
Folder. Enfin, en cliquant droit sur src, vous pourrez créer une nouvelle classe (New Class).
Lors de la création de cette classe, vous pouvez notamment demander à Eclipse de générer
automatiquement pour vous un main(). Vous pouvez aussi spécifier la classe mère de la classe que
vous créez. Par défaut, laissez java.lang.Object dont héritent toutes les classes crées en Java.
Remarquez que vous pouvez également demander la génération automatique des constructeurs
(calquée sur ceux de la classe mère). À vous de jouer pour réaliser votre premier programme
Java sous Eclipse !
Exécution de programme Pour tester votre programme, cliquez droit sur la classe dont vous
voulez exécuter le main() et choisissez Run As Java Application. Pour fournir des arguments
en entrée de votre programme, vous le pouvez en choisissant le mode Run Configurations...
et régler dans l’onglet Java Application les arguments à fournir à votre programme.
Débogueur Si vous souhaitez déboguer un programme, passez dans la perspective Debug
(Window → Open Perspective → Debug) et choisissez Debug As.
1
MIT 1re année - 2011/12
3
Module PROG2
Utilisation des fonctions avancées d’Eclipse
Créez un nouveau projet comme dans la section précédente. Cette fois-ci, vous importerez
les fichiers sources que vous avez réalisés vendredi dernier. Pour importer un fichier source :
cliquer-droit sur le paquet auquel vous voulez ajouter les sources, et dans le menu Import...,
choisissez le type de fichier General → File System, et laissez-vous guider.
Formattage Si vos fichiers sources sont mal formattés, cela peut se corriger facilement en
cliquant droit dans la fenêtre d’édition de code et en choisissant Source → Format (ou avec le
raccourci clavier Ctrl + Maj + T).
Génération de code Un autre item intéressant du menu Source est Generate getters and
setters, qui peut vous permettre, par exemple, de générer les accesseurs aux attributs de votre
classe ComplexMatrix.
Renommage Supposons maintenant que vous souhaitiez changer le nom de la méthode mul
de la classe Complex par multiply. Eclipse propose une manière intelligente de le faire : pour
cela, sélectionnez le nom de la méthode mul, cliquez droit et choisissez Refactor → Rename.
Observez le résultat produit dans la méthode mul de la classe ComplexMatrix.
Auto-complétion L’utilisation de Ctrl + Espace lance l’auto-complétion. Par exemple, si
vous tapez le texte ”Syso” suivi de Ctrl + Espace, Eclipse corrigera automatiquement ”Syso”
en System.out.println(). De même, si c1 est une instance de la classe Complex, c1. suivi
de Ctrl + Espace demande à Eclipse de vous proposer les différents attributs et méthodes
accessibles de la classe Complex.
Pour aller plus loin Vous aurez sans doute besoin de vous familiariser davantage avec Eclipse,
durant les futurs projets. Deux bonnes sources sont :
http://www.vogella.de/articles/Eclipse/article.html
http://help.eclipse.org/indigo/index.jsp
4
Le greffon Subversive
Le greffon Subversive permet d’intégrer les fonctionnalités de travail collaboratif dans Eclipse.
Installation Pour cela, dans le menu Help, choisissez Install New Software... puis, saisissez indigo dans la source de logiciels. Eclipse vous propose la source suivante :
Indigo - http ://download.eclipse.org/releases/indigo
Puis, dans l’onglet Collaboration, cochez (au moins) Subversive SVN Team provider.
Dépôt d’un projet local Si vous avez créé un projet dans Eclipse et que vous souhaitez
l’envoyer sur un dépôt SVN, vous pouvez le faire en cliquant droit sur le nom du projet dans la
Vue Package, en choisissant Team → Share project. Laissez-vous guider.
Récupération d’un projet existant Pour ce faire, créez un nouveau projet. Ce nouveau
projet ne sera pas de type Java Project comme ceux que l’on a vu jusqu’à présent, vous
trouverez le type adéquat sous le répertoire SVN.
2
MIT 1re année - 2011/12
5
Module PROG2
Javadoc
javadoc est un outil de génération automatique de documentation pour du code Java. Cet
outil se base sur les commentaires que vous aurez ajoutés à votre code et les met en forme
pour présenter une documentation complète des classes que vous avez codées, facilitant la prise
en main pour un utilisateur externe au projet. Le style de rendu est identique à celui de la
documentation officielle J2SE que vous avez l’habitude de consulter à l’adresse http://docs.
oracle.com/javase/6/docs/api/. Eclipse contient un assistant Javadoc, mais sachez que ce
n’est qu’une interface de l’utilitaire javadoc en ligne de commande.
Première documentation Pour générer une première version de documentation, sélectionnez
dans l’explorateur de paquet le projet concerné, puis choisissez le menu Project → Generate
Javadoc...
Si la commande Javadoc n’est pas renseignée, spécifiez dans le champ en question le résultat
de la commande which javadoc entrée dans un terminal. Pour le reste, laissez-vous guider et validez la génération de votre première Javadoc. Pour la consulter, il vous suffit, dans l’explorateur
de paquetages, d’étendre le répertoire doc puis de double-cliquer sur le fichier index.html.
Vers une vraie documentation La documentation ainsi générée n’est pas très informative,
puisqu’elle ne fait que résumer les prototypes des méthodes existantes.
Cela vient du fait que vous n’avez pour l’instant, dans votre code, aucun commentaire destiné
à Javadoc. Un tel commentaire est délimité par les caractères /** et */ et chaque nouvelle ligne
de commentaire entre ces délimiteurs commence par une astérisque. Ainsi, la syntaxe suivante
est correcte :
/** Here is some sample text.
* Still some text to be added to the Javadoc...
*/
Vous êtes donc maintenant capables d’insérer une présentation pour chaque méthode. Cette
présentation peut être enrichie à l’aide de tags, dont vous trouverez un résumé à l’adresse http:
//docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#javadoctags.
Vous vous attarderez notamment sur les tags @param et @return.
Enfin, il existe une option à passer à javadoc pour lui signifier d’ajouter le code source à la
documentation produite. C’est l’option -linksource, à spécifier dans le champ Extra javadoc
options.
3