TP4 : Outils associ´es `a Java - Bienvenue sur le site de Jean

TP4 : Outils associ´ es ` a Java
[e-mail]
R&T 2`eme ann´ee
Vous avez `a votre disposition (sur le r´epertoire commun) : le cours, les TDs,
et quelques documents provenant d’Internet. Vous devez prendre l’habitude de re-
chercher l’information dans ces documents et dans le sujet de TP. Chaque question
inutile1sera not´ee et aura des cons´equences sur la note du TP.
But du TP : D´ecouvrir les outils de “production” associ´es `a Java.
1 Cr´
eation de documentation avec Javadoc
1.1 Principe
Lors du d´eveloppement d’application il est judicieux de cr´eer la documentation
du programme au fur et `a mesure (ce qui n’est que rarement fait en r´ealit´e !). Java
propose une m´ethode rapide et simple pour construire la documentation d’un projet
en mˆeme temps que sa construction : javadoc
Des commentaires compris entre /** et */sont rajout´es au code source pour
construire la documentation. Ces commentaires sont plac´es juste avant l’´el´ement
concern´e.
En plus de ces commentaires, quelques mots clefs simples permettent de d´esigner
les param`etres d’une m´ethode, l’auteur d’une classe. . .
Un utilitaire permet ensuite de g´en´erer un ensemble de fichier HTML `a partir de
ces commentaires.
1.2 Commentaires associ´ es aux classes
Les classes sont souvent document´ees pour pr´esenter en quelques lignes leurs
principales fonctionnalit´es. En plus, trois balises permettent d’ajouter des rensei-
gnements :
–@author est suivie du nom de l’auteur de la classe
–@version est utilis´e pour attribuer un num´ero de version `a la classe, permet-
tant ainsi de suivre les ´evolutions.
–@see permet de d´esigner un ´el´ement li´ee (ind´ependamment de l’h´eritage).
/**
*Cette classe permet de decoder un message encode avec le code de Cesar
1qui a sa r´eponse de mani`ere simple dans les fichiers fournis
1

*
*@author jb
*@version 1.0
*@see EncodeCesar
*/
public class DecodeCesar implements Cryptage {
1.3 Commentaires associ´ es aux m´ ethodes
Les commentaires associ´es aux m´ethodes sont les plus utiles, ils permettent
de connaˆıtre l’interface de chaque m´ethodes (ses arguments et son type de retour)
ainsi que la fonctionnalit´e de la m´ethode.
– @param permet de pr´eciser chaque param`etre rec¸u par la m´ethode
– @return d´esigne l’´el´ement renvoy´e par la m´ethode
– @deprecated permet d’indiquer qu’une m´ethode est d ´epr´eci ´ee. Cela signifie
que pour l’instant elle existe toujours pour des raisons de compatibilit´e mais
qu’elle ne doit plus ˆetre utilis´ee dans de nouveaux projets.
/**
*Distribue les cartes de maniere alternee entre deux joueurs
*@param premierJoueur le premier joueur
*@param secondJoueur le second joueur
*/
public void Distribuer(Joueur premierJoueur, Joueur secondJoueur){
1.4 Utilisation avec Eclipse
Eclipse facilite la cr´eation de la documentation. D`es que les caract`eres /** sont
tap´ees au dessus d’une m´ethode, les balises @param et @return sont ajout´ees (si
elles sont n´ecessaires). Il n’y a plus qu’a les compl´eter.
1.5 Cr´
eation de la documentation HTML
La documentation HTML peut ˆetre g´en´er´ee par l’utilitaire javadoc. Le g´en´eration
peut aussi faite avec Eclipse pendant la cr´eation du projet.
Le menu Project propose une entr´ee Generate Javadoc... pour construire la do-
cumentation du projet. Tous les param`etres par d´efaut sont suffisant pour notre
usage, il suffit de cliquer sur Finish. A l’issue de cette op´eration, un r´epertoire doc
est cr´ee dans le projet. Il suffit d’ouvrier le fichier index.html pr´esent dans ce
r´epertoire avec le navigateur pour acc´eder aux pages de documentation g´en´er´ees.
2 Distribution d’un programme Java
Un programme Java est souvent constitu´e de diff´erentes classes et donc autant
de fichiers. Il n’est pas envisageable de distribuer un ensemble de fichiers “en vrac”.
Java propose de regrouper tous ces fichiers dans une seule archive qui sera le seul
fichier distribuer.
2

2.1 Les archives .jar
Les fichiers .jar sont des archives contenant toutes les classes (fichiers .class)
n´ecessaires au fonctionnement d’un projet ainsi que des fichiers de configurations
permettant de v´erifier la validit´e de l’archive ainsi que de sp´ecifier le point d’entr´e
du programme.
Les archives .jar peuvent ˆetre cr´ees en ligne de commande avec l’utilitaire jar
livr´e avec Java. Il est souvent pr´ef´erable d’utiliser l’outil fourni avec son environne-
ment de d´eveloppement.
2.2 Cr´
eation d’une archive avec Eclipse
Cr´eer une archive .jar avec Eclipse est tr`es simple. Dans le menu File, cliquer
sur Export.... Dans la boite de dialogue qui apparaˆıt, choisir Java puis JAR File et
valider. Choisir ensuite le projet `a exporter, et lui donner un nom (dans la boite
de texte `a droite de JAR File) ou choisir un fichier existant. Apr`es avoir cliqu´e sur
Next, une nouvelle boite de dialogue apparaˆıt, g´en´eralement les options par d´efaut
conviennent, continuer en cliquant sur Next. Dans la troisi`eme boite de dialogue,
on peut choisir la classe qui sera ex´ecut´e au d´emarrage dans le champ Main Class
(le bouton Browse permet d’obtenir la liste des classes possibles). Cliquer enfin sur
Finish pour que le fichier .jar soit cr´ee.
2.3 Ex´
ecution d’un fichier .jar
Pour ex´ecuter un programme contenu dans un fichier .jar, il suffit d’utiliser
l’instruction : java -jar MonApplication.jar
3 Travail `
a faire
Reprenez le TP2 (jeu de carte), documentez convenablement votre code et g´en´erez
les fichiers HTML. Ensuite cr´eez un fichier .jar pour pouvoir l’ex´ecuter sur une
autre machine.
3