Gerar Documentação
19/06/2012 12:39
0
Pessoal,

alguem conhece alguma maneira de gerar documentação no Grails? Qual a melhor maneira de gerar a documentação de um sistema Grails?

Eu coloco os comentários das classes, mas não conheço algum meio de fazer com que o mesmo gere um arquivo externo explicando o que eu escrevi sobre elas, semelhante ao Java.


Alguém poderia me ajudar?
Tags: documentação


0
Olá.

Amigo, no Eclipse (STS ou Eclipse com plugin pra Groovy), basta usar a mesma opção "export ->java -> javadoc". Dai no item "Javadoc command" aponte para o caminho do teu comando groovydoc. No windows ele fica em algo como "C:\Program Files (x86)\Groovy\Groovy-1.8.6\bin\groovydoc.bat". No Linux deve ser um arquivo ".sh", eu acredito.
No Netbeans acredito que também funcione.
Dai é só "next next... finish" que o Javadoc tanto de classes Java como Groovy é gerado numa boa ;)

Abraços.


0
Grande José,

Sempre nos ajudando por aqui... mas daí o que eu faço com o arquivo groovydoc.bat para ele gerar a documentação sem a necessidade de uma IDE?

Existe algum meio?
19/06/2012 22:53


0
Olá,

amigo, sem IDE o negócio pega.... teria que usar o comando groovydoc no terminal passando meio mundo de parâmetros... Talvez criando um XML ant ou um script Grandle ajude.

Enfim, a questão é usar o Groovydoc que gera o javadoc de classes Java e Groovy independente de o projeto ser Grails ou não.

#Ficadica Porque não usa a IDE só para gerar a documentação?


0
Tem razão José,

vou usar uma IDE para fazer isso.

Você sabe me dizer se as anotações do Groovydoc são as mesmas do Javadoc ou se existe alguma inovação ou mudança?

20/06/2012 13:23


0
Usei exatamente as mesmas.

Inclusive o "generate javadoc" do Eclipse funciona normal pra classes Groovy. E a refatoração de javadoc também (por exemplo, se renomear o nome de uma parametro ele também é renomeado automaticamente no javadoc).



Ainda não faz parte da comunidade???

Para se registrar, clique aqui.


Aprenda Groovy e Grails com a Formação itexto!

Newsletter Semana Groovy

Assinar

Envie seu link!


Livro de Grails


/dev/All

Os melhores blogs de TI (e em português) em um único lugar!

 
Creative Commons
RSS Grails Brasil é mantido por itexto Consultoria.
Em caso de problemas contacte Henrique Lobo Weissmann (Kico) por e-mail: kico@itexto.com.br
Todo o conteúdo presente neste site adota o Creative Commons como licença padrão.
Ver: 4.14.0
itexto