SoloCodigo

Nos pidieron un trabajo para la U, y no tengo ni las más mínima idea de como hacer la documentación....

El trabajo trata de un comparador de textos, con la finalidad de encontrar el % de similitud.Usamos listas enlazadas y un arbol, y hash....

k me recomiendan....me ayudan???

Te recomiendo hacer el javadoc, viene muy bien para ayudar a entender el código.
Javadoc es el "para qué sirve" cada clase y función; como la API de java.
Antes de cada método escribe un comentario explicando qué hace dicha función.
Cuando acabes, el eclipse tiene una opcion (Project > Generate Javadoc...), elijes el proyecto y ya lo tienes.

Ese comentario debe delimitarse por:
/** (importante el segundo '*')
bla bla bla
*/

Te pongo un ejemplo:
     /**
     * Devuelve el elemento que hay en la posición introducida
     *
     * @param pos posición de la lista que queremos consultar
     * @return elemento que hay en la posicion que consultamos
     * @throws IndexOutOfBoundsException
     */
    public T consultar(int pos) throws IndexOutOfBoundsException {
__ if(pos>0 && pos<=lista.length()){
____ return lista[pos-1];
__ }else{
____ throw new IndexOutOfBoundsException("Posicion incorrecta!");
__ }
    }

Espero haber sido claro. En caso de duda solo hay que decirlo.

PD. No sé si otros programas tendrán la opcion. esto solo lo he hecho en el eclipse pero supongo que se podrá hacer en otros entornos.