générer documentation

Question

Bonjour à tout le monde,
je viens d'écrire une appli avec Eclipse et maintenant je voudrais générer sa documentation. Existe t il une "norme" en la matiere ? Comment la générer ou la créer et avec quel logiciel. Est-il possible de générer l'architecture générale de l'appli, une sorte d'arbre montrant la communication entre les classes. Je ne pense pas que l'UML permette de faire ca ?

Sinon rien a voir avec ce que je viens d'ecrire :
pourquoi dans les zones de texte des webmail et des forums arrive t il la chose suivante : 
vous etes entrain d'écrire du texte vous fait une faute de frappe, vous voulez faire une correction vous appuyé sur la touche au dessus de "enter" pour revenir et la c'est le drame : retour a la page precedente et tout le texte est effacé pas cool.

Mais bon ma vraie question est sur les documentations 
merci par avance

cs_neodante · Answer

:big) Neodante :big) 

Dans le menu projet : Generate javadoc ... c tout ...
S'il n'apparait pas sélectionne ton projet dans l'explorateur ...
@+

[Responsable www.neogamedev.com]

gmi19oj19 · Answer

ou javadoc [options] liste_des_classes_dont_tu_veux_la_doc

gmi19oj19

anisotrope · Answer

Merci ca fonctionne 
Maintenant comment renseigner les méthod summary car pour l'instant la description est assez courte exemple :

boolean add_point_mat(int x, int y)  

 je voudrais que soit décrit par exemple ce que fait la méthode et quelle sont ses conditions d'utilisation.
J'ai essaye dans le fichier java au dessus du debut de la méthode add_point_mat :

// cette methode ajoute un point(x,y) 
//a la matrice de classe A / A[x][y]=1

Mais rien n'est ajouté dans les docs.

Comment faire merci

cs_neodante · Answer

:big) Neodante :big) 

Sous Eclipse ajoute simplement /** et {entré} et ça génére un squelette de commentaires pour ta fonction ou ta classe ...
@+

[Responsable www.neogamedev.com]

Générer documentation

4 réponses

Votre réponse

Discussions similaires