Como obter os comtários de uma dada Classe ou método?

5 respostas
R

Preciso de uma função que dado um método de uma classe me imprima os comentários que esse método tem.

Exemplo:
Se tivesse como parametro de entrada o seguinte método iria ter como resposta o comentário com os respectivos atributos que estão comentados…

/**
 *Método que faz a multiplicação de 2 inteiros
 * @param m1 multiplicador1
 * @param m2 multiplicador2
 * @return m3 resultado
 */
public int multi (int m1, int m2){
    int m3 =m1*m2;
    System.out.println(m1+"x"+m2+"="+m3);
    return m3;

5 Respostas

A

Imprimir o comentário do método? Nunca ví isso não…

E

ricardonisa:
Preciso de uma função que dado um método de uma classe me imprima os comentários que esse método tem.

Exemplo:
Se tivesse como parametro de entrada o seguinte método iria ter como resposta o comentário com os respectivos atributos que estão comentados…

/**
 *Método que faz a multiplicação de 2 inteiros
 * @param m1 multiplicador1
 * @param m2 multiplicador2
 * @return m3 resultado
 */
public int multi (int m1, int m2){
    int m3 =m1*m2;
    System.out.println(m1+"x"+m2+"="+m3);
    return m3;

Os comentários não são guardados no arquivo .class. Em vez disso, você pode escrever um “doclet” para processar seus arquivos-fontes e separar os comentários.

http://download.oracle.com/javase/6/docs/technotes/guides/javadoc/doclet/overview.html

eltonads

Acho que nesse seu caso, anotações seriam mais interessantes…

Att.,

Mikhas

Para que você precisa disso? Qual sua real intenção com isso?

EDIT: Dependendo do que você quer, você pode usar o JavaDoc

E

Eu em particular acho os javadocs gerados pela ferramenta Javadoc horríveis. Se eu tivesse um monte de tempo, talvez gerasse algo semelhante ao doxygen:

http://www.stack.nl/~dimitri/doxygen/

Ele é mais para fazer documentação de programas em C++, mas aceita Java. Infelizmente, ele não usa internamente um compilador Java e pode eventualmente cometer alguns erros.

Isso é perfeitamente possível fazer a mesma coisa criando uma doclet.

Seguem vários exemplos de sites que mostram documentação de programas usando o doxygen.

http://www.stack.nl/~dimitri/doxygen/projects.html

Um diagrama de classes da biblioteca que vem com o g++.

http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/inherits.html

Criado 3 de novembro de 2010
Ultima resposta 4 de nov. de 2010
Respostas 5
Participantes 5