Documentacao do programa

7 respostas
G

Boa tarde, novamente !

Só pra complementar o comentário, ja na minha primeira aula de java na facu, a primeira coisa que eu percebi e que quando se insere os comentarios para documentacao do programa, ele fica enorme, existe uma ordem cronologica para se fazer isso, ou eu posso fazer todo o codigo do programa e documenta-lo no final, antes de fecha-lo ?

obrigado

gregorio

7 Respostas

kuchma

Voce pode documeta-lo quando quiser. E se quiser. :mrgreen:

Brincadeiras a parte, considero o ideal ir documentando a medida que se vai escrevendo/atualizando o codigo. Pois depois de algumas semanas voce pode nao lembrar o que o codigo faz. E, considerando que isso aconteca e voce nao consiga “lembrar” o que ele faz apos uma rapida leitura, entao eh sinal de que alem do javadoc ele precisa de outra coisa: refactoring. :smiley:

Quanto a poluicao visual da tela com os comentarios, use o Eclipse 3 com recurso de “folding” (que termo usar para isso em portugues?).

Marcio Kuchma

caiofilipini

Que tal “folding”? :mrgreen:

Sei lá, acho que alguns termos ficam estranhos demais quando traduzidos…

G

Na facu estamos usando o Jcreator, esse eclipse seria mais indicado para novatos que nem eu ?

valeu, e foda ne, e duvida que nao acaba mais, e isso pq o professor de nos da aula de java e um monstro na materia, a proposito se os colegas quiserem dar uma olhada no site do cara e esse aki:

www23.brinkster.com/profpedrassa

E isso ai, t+

gregorio :slight_smile:

T

Deixe como está, o JCreator também tem “code folding”.

Acho que seu professor o usa para evitar ter de arrumar umas máquinas muito poderosas para rodar IDE’s 100% Java, como o NetBeans ou o Eclipse (tá bom, o Eclipse é 80% Java e 20% C++…) Como o JCreator é escrito em C++, não precisa de tanta memória quanto essas IDEs.

É legal aprender a usar o Eclipse (da IBM) ou o NetBeans (da Sun) também, porque normalmente são essas ferramentas que são usadas profissionalmente (por exemplo, se no seu estágio o pessoal usa IBM Websphere ou JBoss provavelmente é o Eclipse ou o WSAD que eles usam).
Mas isso você pode fazer no seu estágio. Na sala de aula use o JCreator mesmo.

Guilherme_Silveira

Na realidade, dependendo da metodologia de desenvolvimento que sua empresa usa, existe um momento correto para gerar documentacao do seu programa.

Vale lembrar que existe diferenca entre:

  • comentarios: codigos do tipo // ou /* */ dentro de metodos que servem para explicar algo que pode nao ser tao legivel. Nao coloque um comentario a cada duas linhas, piora a legibilidade do codigo

  • documentacao: essa deve ser feita a parte em algum outro programa e PODE ser incrementada com o javadoc (/** */) que torna o codigo do aruiqvo .java bem maior… claro que se seu chefe pegar um codigo sem javadoc vai ficar bem fulo…

Por fim, dependendo da metodologia, voce sera obrigado a primeiro modelar seu UML, depois gerar a documentacao da classe e codificar ao mesmo tempo.

Pessoalmente, acho meio inviavel gerar documentacao durante as primeiras etapas de desenvolvimento, quando nada e’ muito solido e muda muito. Melhor comecar so comentando e depois de algo mais estavel comecar a documentar e entao ficar sempre no codifica+documenta…

Nao esqueca que definicoes de como os componentes trabalham entre si etc vao precisar de esforco maior e ficam normalmente em outros arquivos…

Abraco

Guilherme Silveira

A

Boa tarde !

Essa questao do uso da uml e que ainda nao foi bem abordada no meu curso, mas ja percebi que sera muito aplicado na programacao, ne, agora com relacao a documentacao, seria mais indicado entao dar inicio a documentacao quando o codigo estiver mais estruturado, e isso ??

E quanto ao programa que usamos entao, esse jcreator e mais a nivel academico mesmo, ele nao e usando a nivel profissional, mas essas outras plataformas mencionadas tem grande diferenca entre si, como e isso ?? pq se mudarem apenas alguns detalhes achei essa ferramenta ate legal ! :})

Alguem na lista trabalha como programador java ? alguem poderia me dar uma dica de como e o mercado de trabalho para quem esta na area ou pra tem quem interesse em entrar ?

Eu tenho uma duvida muito grande com relacao as profissioes, gosto muito de hardware, software, nao manjo nada de programacao, mas sempre achei muito interessante, como sou fa de jogos gostaria de aprender como um hobby, a programar pra jogos no futuro, e na minha faculdade, o nosso professor de bando de dados e consultor dba da oracle, e ele vive se gabando da profissao dele, e eu acho que francamente nao deve ser bem por ai, ta certo que um dba de uma empresa como oracle deve ganhar muito bem e deve ser um profissao de muito respeito no mercado, mas eu particularmente acho que existem outras de muito destaque tb, por isso esotu pedindo a opiniao de vcs !

Guilherme_Silveira

posso dar um toque nos dois primeiros pontos:

  • uml eh bastante utilizado, mas denovo, depende do projeto e da metodologia

  • parece que o jcreator eh usado na sua facu por ser mais leve, nao tao pesado quanto os outros ides… o eclipse, netbeans, wsad etc sao os mais utilizados no mercado pago. no open source voce possui uma liberdade maior, cada um do time usa uma ide e todo mundo faz tudo funcionar direitinho

  • creio que boa parte do forum trabalhe como programador, so nao sei dizer sobre o pessoal que esta entrando no mercado agora

atenciosamente

Anonymous:
Boa tarde !

Essa questao do uso da uml e que ainda nao foi bem abordada no meu curso, mas ja percebi que sera muito aplicado na programacao, ne, agora com relacao a documentacao, seria mais indicado entao dar inicio a documentacao quando o codigo estiver mais estruturado, e isso ??

E quanto ao programa que usamos entao, esse jcreator e mais a nivel academico mesmo, ele nao e usando a nivel profissional, mas essas outras plataformas mencionadas tem grande diferenca entre si, como e isso ?? pq se mudarem apenas alguns detalhes achei essa ferramenta ate legal ! :})

Alguem na lista trabalha como programador java ? alguem poderia me dar uma dica de como e o mercado de trabalho para quem esta na area ou pra tem quem interesse em entrar ?

Eu tenho uma duvida muito grande com relacao as profissioes, gosto muito de hardware, software, nao manjo nada de programacao, mas sempre achei muito interessante, como sou fa de jogos gostaria de aprender como um hobby, a programar pra jogos no futuro, e na minha faculdade, o nosso professor de bando de dados e consultor dba da oracle, e ele vive se gabando da profissao dele, e eu acho que francamente nao deve ser bem por ai, ta certo que um dba de uma empresa como oracle deve ganhar muito bem e deve ser um profissao de muito respeito no mercado, mas eu particularmente acho que existem outras de muito destaque tb, por isso esotu pedindo a opiniao de vcs !

Criado 9 de novembro de 2004
Ultima resposta 10 de nov. de 2004
Respostas 7
Participantes 6