Javadoc

[dany80]

Slave mi spiegate come funziona lo strumento javadoc...possibilmente con un esempio..grazie!!

[andbin]

Originariamente inviato da dany80
Slave mi spiegate come funziona lo strumento javadoc...possibilmente con un esempio..grazie!!

Devi generare la documentazione javadoc per del tuo codice? E hai già scritto i commenti javadoc?

Se così, l'ultimo passo è solo invocare il tool 'javadoc'. Se stai usando un IDE di un certo livello, sicuramente offre un "wizard" o simile per generare la documentazione javadoc. Altrimenti puoi comunque farlo "a mano".

I dubbi quali sono? Come lanciare javadoc? Quali parametri passare?

[dany80]

allora i commenti li ho inseriti dappertutto in questo modo
/**
commento
*/

ma quando genero la documentazione in html non leggo i commenti, da me inseriti, da nessuna parte ma solo la documentazione.
Ho letto da qualche parte che devo inserire prima @import...ma niente!!

[Patrick Jane]

Originariamente inviato da dany80
allora i commenti li ho inseriti dappertutto in questo modo
/**
commento
*/

ma quando genero la documentazione in html non leggo i commenti, da me inseriti, da nessuna parte ma solo la documentazione.
Ho letto da qualche parte che devo inserire prima @import...ma niente!!

/**
 *@param a numero da moltiplicare
 *@param b secondo numero da moltiplicare
 *@return restituisce il prodotto di a*b
  */

int mul(int a, int b) {
  return a*b;

Se hai fatto così dovrebbe andare..

[dany80]

ma in qualsiasi parte del cosice??

[dany80]

fatto ma non leggo i miei commenti!!!

[andbin]

Esempio super-basilare:

Struttura file/directory:

XYZ/src/com/esempio/StringUtils.java
XYZ/doc

Nota 1: XYZ = una qualunque directory.
Nota 2: doc è inizialmente vuota.

StringUtils.java contiene:

package com.esempio;

/**
 * La classe <code>StringUtils</code> contiene metodi di utilità
 * per le stringhe.
 *
 * @author   nomeautore
 * @version  1.0
 */
public class StringUtils {
    private StringUtils() {}

    /**
     * Rovescia il contenuto di una stringa.
     *
     * @param   str  la stringa in ingresso.
     * @return  la stringa rovesciata.
     */
    public static String rovesciaStringa(String str) {
        char[] buf = str.toCharArray();

        for (int i = 0; i < buf.length/2; i++) {
            char t = buf[i];
            buf[i] = buf[buf.length-i-1];
            buf[buf.length-i-1] = t;
        }

        return new String(buf);
    }
}

Da prompt dei comandi, stando come directory "corrente" nella XYZ, dare:

javadoc -sourcepath src -d doc -author -version -subpackages com

Questo è già sufficiente per generare una documentazione javadoc.

[dany80]

quest'è è il mio file...

[dany80]

Grazie

[Patrick Jane]

@param è return sono da assegnare solo a metodi e costruttori, infatti param = parametro