EXERCICE 1:
Faire l'analyse du fichier ‘tpoint2d.java’ en adoptant la notation
L.A.O. et en corrigeant le passage par valeur des références
d'objets (cf. méthode ‘echange’)
ANNEXE
1 : L'UTILITAIRE 'javadoc' de Sun
Microsystems
--------------------------------------------------------
Etudier
le fichier "tpoint2d.java" quant aux emplacements des commentaires
‘javadoc’ et pour en extraire les principaux mots-clés (@private, @author,
@version, @param, @return, @see, @since …)
Solution
typique:
----------------
En
tapant les lignes ci-dessous:
javadoc
*.java
javadoc -private *.java
javadoc -private -author
*.java
javadoc -private -author -version *.java
on
produit ainsi tous les fichiers '.html' dont le fichier 'tpoint2d.html' (et les
fichiers point2d.html, es.html etc ...) qui documentent le programme en
question. Avec un navigateur Web approprié (Mozilla ou IE …), on peut consulter
cette documentation en cliquant sur le
fichier 'index.html'.
Option
'-private':
-----------------
Elle est nécessaire pour les classes non
publiques, les champs privés (i.e. encapsulés) et les méthodes privées si l'on veut lire les
commentaires correspondants. Par défaut, cette option est omise ainsi que
celles qui suivent.
Option
'-author':
----------------
Elle est nécessaire pour afficher le(s)
nom(s) de l'auteur ou des auteurs qui doivent être placés après le paramètre
'@author'.
Option
'-version':
----------------
Elle est nécessaire pour afficher la version courante
et/ou des mises à jours ('update') qui doivent être placées après le paramètre
'@version'.
Les
mots-clés sont donc placés après le caractère '@' pour fournir à 'javadoc'
certaines précisions:
@author : nom
du/des programmeur(s);
@version
: numéro de version récente;
@since :
numéro de version précédente ;
@param : nom
de l'argument (ou paramètre) suivi d'un commentaire;
@return : nom
du paramètre retourné avec son commentaire
@see :
nom d'une classe associée (composée / héritée) à consulter.
Remarques:
---------
Chaque classe, chaque attribut et chaque
méthode sont précédés d'un commentaire de documentation délimité par "/**" et
"*/", qui apparaît dans le fichier 'html'. Dans le fichier
d'index, SEULE la première ligne de commentaire est présentée.
On peut aussi produire une documentation pour
un ou plusieurs paquets par:
javadoc -private
un_nom_de_paquet
ou
javadoc -private
une_liste_de_paquets_séparés_par_espaces
De
même, quant au paquet par défaut situé dans le dossier courant, afin d'obtenir
les liens entre les différents fichiers comportant des classes publiques, on
tape:
javadoc *.java
ou
javadoc
-private *.java
etc...
Conseil:
Il est vivement conseillé d’ajouter désormais des commentaires ‘javadoc’
dans les codes sources Java pour les TPPs et le(s) TP-Projet(s) …
EXERCICE 2: Décomposer le fichier
‘tpoint2d.java’ en deux fichiers séparés respectivement dans les paquets 'esstin.outils' et 'esstin.test' (cf. TD-ASDJ#02 2007 - 2008).
ANNEXE 2:
cf. fichier ‘tpoint2d.java’
à analyser, compléter et déboguer …
--------------
------------------------------------------------------------