Javadoc II

Aldee Messages postés 47 Date d'inscription jeudi 18 avril 2002 Statut Membre Dernière intervention 3 mai 2003 - 3 mai 2003 à 18:01
CoreBreaker Messages postés 540 Date d'inscription dimanche 23 mars 2003 Statut Membre Dernière intervention 5 octobre 2007 - 6 mai 2003 à 21:01
Bonjour,

J'ai progressé dans l'utilisation de javadoc grâce à vos indications, je vous remercie.

Mais, n'ayant pas fait de html, il me manque certaines infos qui semblent tellement connues qu'elles sont difficiles à trouver.

Voilà. Dans une commentaire /** commentaire */ pour sauter une ligne, on utilise la balise : /** commentaire suite du commentaire*/.
Oui, mais...
Je voudrais juste faire un retour à la ligne (sans sauter une ligne en plus), et je ne trouve pas commment faire, même en épluchant le lien javadoc de sun.

Pouvez-vous m'aider.
D'avance merci.

3 réponses

cs_Duss Messages postés 890 Date d'inscription lundi 8 avril 2002 Statut Membre Dernière intervention 29 juillet 2004 11
3 mai 2003 à 21:56
salut

Duss
0
cs_BlackWood Messages postés 37 Date d'inscription mardi 15 avril 2003 Statut Membre Dernière intervention 4 octobre 2006 2
5 mai 2003 à 16:03
Salut !

Je ne sais pas quel est ton but de sauter une ligne, peut-être pour la mise en page tout simplement, je ne sais pas. Mais si par hasard c'est pour indiquer les paramètres, ou ce que la methode retourne, sais-tu qu'il existe des commandes spéciales pour ça ? C'est d'ailleurs trés utile et indispensable si on veut arriver à une superbe JavaDoc de son programme !
J'ai mis la javadoc de mes classes Arme et Armure dans mon projet JavaWar du labo (D'ailleurs, si tu veux en faire parti, tu es le bienvenu.). C'est un excellent exemple mais je n'ai pas donné le code. Donc le voici. Je l'ai écrite à la façon "JDK" avec vraiment tout ce qu'on peut mettre...

/**
 * La classe Arme construit une arme avec ses différents attributs
 *
 * @author	BlackWood
 * @version Beta	23/04/03
 */
public class Arme {

/**
 * Nom de l'arme
 * @see #getNom()
 * @see #setNom(String)
 */
public String nom;
/**
 * Portée de l'arme
 * @see #getPortee()
 * @see #setPortee(int)
 */
public int portee;
/**
 * Type de l'arme
 * @see #getType()
 * @see #setType(int)
 */
public int type;
/**
 * Force de l'arme contre les non-blindés
 * @see #getVsNB()
 * @see #setVsNB(int)
 */
public int vsNB;
/**
 * Force de l'arme contre les blindés
 * @see #getVsB()
 * @see #setVsB(int)
 */
public int vsB;

/**
 * Construit une nouvelle Arme
 * @param 	nom		Nom de l'arme
 * @param	portee	Portée de l'arme
 * @param 	type	Type de l'arme
 * @param	vsNB	Force de l'arme contre les non-blindés
 * @param	vsB		Force de l'arme contre les blindés
 */
public Arme(String nom,int portee,int type,int vsNB,int vsB) {
this.nom	= nom;
this.portee	= portee;
this.type	= type;
this.vsNB	= vsNB;
this.vsB	= vsB;
}

/**
 * Retourne le nom de l'arme
 * @return	Le nom de l'arme
 * @see		setNom(String)
 */
public String getNom()	{ return nom;}
/**
 * Retourne la portée de l'arme
 * @return	La portée de l'arme
 * @see		setPortee(int)
 */
public int getPortee()	{ return portee;}
/**
 * Retourne le type de l'arme
 * @return	Le type de l'arme
 * @see		setType(int)
 */
public int getType() 	{ return type;}
/**
 * Retourne la force de l'arme contre les non-blindés
 * @return	la force de l'arme contre les non-blindés
 * @see		setVsNB(int)
 */
public int getVsNB()	{ return vsNB;}
/**
 * Retourne la force de l'arme contre les blindés
 * @return	la force de l'arme contre les blindés
 * @see		setVsB(int)
 */
public int getVsB()		{ return vsB;}

/**
 * Configure le nom de l'arme
 * @param	nom		Nom de l'arme
 * @see		getNom()
 */
public void setNom(String nom)		{ this.nom = nom;}
/**
 * Configure la portee de l'arme
 * @param	portee	Portee de l'arme
 * @see		getPortee()
 */
public void setPortee(int portee)	{ this.portee = portee;}
/**
 * Configure le type de l'arme
 * @param	type	Type de l'arme
 * @see		getType()
 */
public void setType(int type)		{ this.type = type;}
/**
 * Configure la force de l'arme contre les non-blindés
 * @param	portee	Force de l'arme contre les non-blindés
 * @see		getVsNB()
 */
public void setVsNB(int vsNB)		{ this.vsNB = vsNB;}
/**
 * Configure la force de l'arme contre les blindés
 * @param	portee	Force de l'arme contre les blindés
 * @see		getVsB()
 */
public void setVsB(int vsB)			{ this.vsB = vsB;}

/**
 * Methode toString
 * @return L'arme
 */
public String toString() {
String s="";
s+="Arme   : "+nom+"\n";
s+="Portee : "+portee+"\n";
s+="Type   : "+type+"\n";
s+="Valeur NB : "+vsNB+"\n";
s+="Valeur B  : "+vsB;
return s;
}
}



BlackWood
0
CoreBreaker Messages postés 540 Date d'inscription dimanche 23 mars 2003 Statut Membre Dernière intervention 5 octobre 2007 1
6 mai 2003 à 21:01
Utilise
à la place

Core Breaker :)
0
Rejoignez-nous