Problema con il generazione dei javadoc

[Neptune]

Salve,
ho un problema nella creazione dei javadoc, ovvero ho capito che devo mettere tutto tra /** e */, non capisco però perchè, seppure metto dei commenti javadoc anche prima dei metodi per spiegarne il comportamento poi questi non mi appaiono nella parte dei metodi.

Di suo mi vede solo il costruttore ed i commenti del costruttore, oltre che i commenti della classe, ma dei metodi no. Non è che mi sfugge qualche parola chiave da inserire per commentare i metodi? se si quale?

Vi rigranzio in anticipo,
neptune.

[Alex'87]

Originariamente inviato da Neptune
Salve,
ho un problema nella creazione dei javadoc, ovvero ho capito che devo mettere tutto tra /** e */, non capisco però perchè, seppure metto dei commenti javadoc anche prima dei metodi per spiegarne il comportamento poi questi non mi appaiono nella parte dei metodi.

Di suo mi vede solo il costruttore ed i commenti del costruttore, oltre che i commenti della classe, ma dei metodi no. Non è che mi sfugge qualche parola chiave da inserire per commentare i metodi? se si quale?

Vi rigranzio in anticipo,
neptune.

Facci vedere un esempio di quello che hai scritto...

[Neptune]

Originariamente inviato da Alex'87
Facci vedere un esempio di quello che hai scritto...

Ad esempio questa è la classe FrequentPattern:

/**

 La classe FrequentPattern che rappresenta un itemset (o pattern) frequente</p>*/


public class FrequentPattern {

	/**

Attributi</p>
	*

private Item fp[]; array che contiene riferimenti a oggetti istanza della
	*classe Item che definiscono il pattern</p>*/
	private Item fp[];
	
	/**

private float support; valore di supporto calcolato per il pattern fp</p>*/
	private float support;
	
	/**

Metodi</p>
	*

FrequentPattern()</p>
	*

Input:</p>
	*

Output:</p>
	*

Comportamento: costruttore che alloca fp come array di dimensione 0</p>*/
	FrequentPattern(){
		fp=new Item[0];
	}
	
	/**

void addItem(Item item)</p>
	*

Input: oggetto Item da aggiungere al pattern</p>
	*

Output:</p>
	*

Comportamento: si estende la dimensione di fp di 1 e si inserisce il
	*ultima posizione líargomento della procedura</p>*/
	void addItem(Item item)
	{
		int length =fp.length;
		
		Item temp []=new Item[length+1];
		System.arraycopy(fp, 0, temp, 0, length);
		temp [length]=item;
		fp=temp;
		
		
	}
	
	/**

Item getItem(int index)</p>
	*

Input: posizione in fp</p>
	*

Output: Item che occupa la posizione indicata in fp</p>
	*

Comportamento: restituisce l'item in posizione index di fp</p>*/
	Item getItem(int index)
	{
		return fp[index];
	}
	
	/**

float getSupport()</p>
	*

Input:</p>
	*

Output: valore di supporto del pattern</p>
	*

Comportamento: restituisce il membro support</p>*/
	float getSupport()
	{
		return support;
	}
	
	/**

@method int getPatternLength()</p>
	*

@param Input:</p>
	*

@retrun Output: lunghezza del pattern</p>
	*

Comportamento: restituisce la dimensione (lunghezza) di fp</p>*/
	int getPatternLength()
	{
		return fp.length;
	}
	
	/**

void setSupport(float support)</p>
	*

Input: valore di supporto del pattern</p>
	*

Output:</p>
	*

Comportamento: assegna al membro support il parametro della procedura </p>*/
	void setSupport(float support)
	{
		this.support = support;
	}
	
	/**

@method public String toString()</p>
	*

@param Input</p>:
	*

@retrun Output: stringa rapresentante item set e supporto</p>
	*

Comportamento: si scandisce fp al fine di concatenare in una stringa
	*la rappresentazione degli item; alla fine si concatena il supporto</p>*/
	
	public String toString(){
		String value="";
		for(int i=0;i<fp.length-1;i++)
			value+=fp[i] +" AND ";
		if(fp.length>0){
			value+=fp[fp.length-1];
			value+="["+support+"]";
		}
		
		return value;
	}


}

E mi fa apparire nel javadoc solo il costruttore ed il tostring e il commento generale della classe, ma non i commenti degli altir metodi.

[Alex'87]

Originariamente inviato da Neptune
E mi fa apparire nel javadoc solo il costruttore ed il tostring e il commento generale della classe, ma non i commenti degli altir metodi.

Non te li fa apparire perché non sono pubblici. Ad ogni modo, che orrore! Non è così che si fa il javadoc di una classe, mi sa che hai le idee piuttosto confuse. Innanzitutto togli tutti quei tag

[b], non ti servono a nulla: la documentazione in output ha già una sua formattazione. E togli quelle robe tipo "input: blabla output: blablabla" e usa i veri "comandi" javadoc come @param e @return. Ad esempio:

/**
 * Aggiunge un oggetto al pattern.
 * @param item L'oggetto da aggiungere.
 */
public void addItem(Item item) {
...
}

/**
 * Restituisce la lunghezza del pattern.
 * @return la lunghezza del pattern
 */
public int getPatternLength() {
...
}

[Neptune]

Originariamente inviato da Alex'87
Non te li fa apparire perché non sono pubblici. Ad ogni modo, che orrore! Non è così che si fa il javadoc di una classe, mi sa che hai le idee piuttosto confuse. Innanzitutto togli tutti quei tag

[b], non ti servono a nulla: la documentazione in output ha già una sua formattazione. E togli quelle robe tipo "input: blabla output: blablabla" e usa i veri "comandi" javadoc come @param e @return. Ad esempio:

/**
 * Aggiunge un oggetto al pattern.
 * @param item L'oggetto da aggiungere.
 */
public void addItem(Item item) {
...
}

/**
 * Restituisce la lunghezza del pattern.
 * @return la lunghezza del pattern
 */
public int getPatternLength() {
...
}

Quindi mi stai dicendo che il javadoc sulle classi non pubbliche non viene proprio generato? Cioè è destinato ai soli utilizzatori ? Quindi uno che deve reimplementare delle classi, o aggiustarle o altro non si può avvalere dei javadoc? Cioè è pensato che chi le reimplementa ha il codice sorgente e quindi si legge direttamente i commenti nel codice, chi la utilizza ha solo il bytecode e quindi usa i javadoc?