TP4 : Outils associ´es `a Java - Bienvenue sur le site de Jean
publicité
TP4 : Outils associés à Java [email protected] R&T 2ème année Vous avez à votre disposition (sur le répertoire commun) : le cours, les TDs, et quelques documents provenant d’Internet. Vous devez prendre l’habitude de rechercher l’information dans ces documents et dans le sujet de TP. Chaque question inutile1 sera notée et aura des conséquences sur la note du TP. But du TP : Découvrir les outils de “production” associés à Java. 1 Création de documentation avec Javadoc 1.1 Principe Lors du développement d’application il est judicieux de créer la documentation du programme au fur et à mesure (ce qui n’est que rarement fait en réalité !). Java propose une méthode rapide et simple pour construire la documentation d’un projet en même temps que sa construction : javadoc Des commentaires compris entre /** et */ sont rajoutés au code source pour construire la documentation. Ces commentaires sont placés juste avant l’élément concerné. En plus de ces commentaires, quelques mots clefs simples permettent de désigner les paramètres d’une méthode, l’auteur d’une classe. . . Un utilitaire permet ensuite de générer un ensemble de fichier HTML à partir de ces commentaires. 1.2 Commentaires associés aux classes Les classes sont souvent documentées pour présenter en quelques lignes leurs principales fonctionnalités. En plus, trois balises permettent d’ajouter des renseignements : – @author est suivie du nom de l’auteur de la classe – @version est utilisé pour attribuer un numéro de version à la classe, permettant ainsi de suivre les évolutions. – @see permet de désigner un élément liée (indépendamment de l’héritage). /** * Cette classe permet de decoder un message encode avec le code de Cesar 1 qui a sa réponse de manière simple dans les fichiers fournis 1 * * @author jb * @version 1.0 * @see EncodeCesar */ public class DecodeCesar implements Cryptage { 1.3 Commentaires associés aux méthodes Les commentaires associés aux méthodes sont les plus utiles, ils permettent de connaı̂tre l’interface de chaque méthodes (ses arguments et son type de retour) ainsi que la fonctionnalité de la méthode. – @param permet de préciser chaque paramètre reçu par la méthode – @return désigne l’élément renvoyé par la méthode – @deprecated permet d’indiquer qu’une méthode est dépréciée. Cela signifie que pour l’instant elle existe toujours pour des raisons de compatibilité mais qu’elle ne doit plus être utilisée 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éation de la documentation. Dès que les caractères /** sont tapées au dessus d’une méthode, les balises @param et @return sont ajoutées (si elles sont nécessaires). Il n’y a plus qu’a les compléter. 1.5 Création de la documentation HTML La documentation HTML peut être générée par l’utilitaire javadoc. Le génération peut aussi faite avec Eclipse pendant la création du projet. Le menu Project propose une entrée Generate Javadoc... pour construire la documentation du projet. Tous les paramètres par défaut sont suffisant pour notre usage, il suffit de cliquer sur Finish. A l’issue de cette opération, un répertoire doc est crée dans le projet. Il suffit d’ouvrier le fichier index.html présent dans ce répertoire avec le navigateur pour accéder aux pages de documentation générées. 2 Distribution d’un programme Java Un programme Java est souvent constitué de différentes 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écessaires au fonctionnement d’un projet ainsi que des fichiers de configurations permettant de vérifier la validité de l’archive ainsi que de spécifier le point d’entré du programme. Les archives .jar peuvent être crées en ligne de commande avec l’utilitaire jar livré avec Java. Il est souvent préférable d’utiliser l’outil fourni avec son environnement de développement. 2.2 Création d’une archive avec Eclipse Créer une archive .jar avec Eclipse est très 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 à exporter, et lui donner un nom (dans la boite de texte à droite de JAR File) ou choisir un fichier existant. Après avoir cliqué sur Next, une nouvelle boite de dialogue apparaı̂t, généralement les options par défaut conviennent, continuer en cliquant sur Next. Dans la troisième boite de dialogue, on peut choisir la classe qui sera exécuté au démarrage 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ée. 2.3 Exécution d’un fichier .jar Pour exécuter un programme contenu dans un fichier .jar, il suffit d’utiliser l’instruction : java -jar MonApplication.jar 3 Travail à faire Reprenez le TP2 (jeu de carte), documentez convenablement votre code et générez les fichiers HTML. Ensuite créez un fichier .jar pour pouvoir l’exécuter sur une autre machine. 3
