| Autor |
Mensagem |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 26/12/2007 18:44:09
|
s4nchez
Virtual Machine Man
![[Avatar]](/images/avatar/bef4d169d8bddd17d68303877a3ea945.jpg)
Membro desde: 05/06/2006 11:35:55
Mensagens: 510
Localização: London, UK
Online
|
dedejava wrote:É complicado mesmo.
Eu penso que o código deve ter 2 requisitos importantes, além de funcionar (óbeveo): nomes de variáveis auto-explicativas e javadoc.
Eu troco o javadoc por testes. Se o programador realmente escreveu bem o seu código, este não só será legível como existirão testes pra demonstrar na prática onde o programador queria chegar quando escreveu aquilo.
Em todos os meus últimos projetos a facilidade de entender o código era diretamente proporcional a quantidade e qualidade dos testes existentes...
|
Ivan Sanchez | coding dojo | blog | twitter |
|
|
 |
|
|
![[Post New]](/templates/default/images/icon_minipost_new.gif) 26/12/2007 19:13:05
|
jack_-_ganzha
JavaEvangelist
![[Avatar]](/images/avatar/847cc55b7032108eee6dd897f3bca8a5.jpg)
Membro desde: 31/03/2003 13:18:12
Mensagens: 315
Localização: Recife - Pernambuco
Offline
|
s4nchez wrote:Eu troco o javadoc por testes. Se o programador realmente escreveu bem o seu código, este não só será legível como existirão testes pra demonstrar na prática onde o programador queria chegar quando escreveu aquilo.
Em todos os meus últimos projetos a facilidade de entender o código era diretamente proporcional a quantidade e qualidade dos testes existentes...
Totalmente de acordo. E acho que lendo documentação vc não aprende exatamente a ler código. Ler e escrever código é que ensinam a... erhm... ler e escrever código.
valeuz...
|
Marcos Silva Pereira
http://www.javafree.org
http://marcospereira.wordpress.com |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 26/12/2007 19:26:40
|
Andre Brito
Forum Spammer
![[Avatar]](/images/avatar/4dff7cccfc092f41b8170fc6d7dc93c0.jpg)
Membro desde: 21/07/2007 17:44:31
Mensagens: 1214
Localização: Paraná
Offline
|
O que eu disse não quer dizer que ele somente terá aquilo. Mas é uma coisa básica que, na minha opinião, o código deve ter.
|
balboa is jamming.
"We couldn't find a good UML tool for our community. So our community built one. You guys are awesome."
TopCoder
Stop blaming everything (and everybody) else for your own laziness.
|
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 08:57:44
|
AndrewAguiar
JavaChild
Membro desde: 18/07/2006 10:03:59
Mensagens: 124
Offline
|
s4nchez wrote:Eu troco o javadoc por testes. Se o programador realmente escreveu bem o seu código, este não só será legível como existirão testes pra demonstrar na prática onde o programador queria chegar quando escreveu aquilo.
Eu discordo, imaginem se o pessoal da sun seguisse esta linha de raciocínio.. acho que documentação com javadoc é extremamente importante, porém o que ocorre é que tem gente que escreve uma monografia sobre o método.
A documentação do Método deve ser simples e rápida.
|
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 09:00:24
|
TeiTei
Virtual Machine Man
![[Avatar]](/images/avatar/34d9646a6c7d6c0de3ece3de6f06a91f.jpg)
Membro desde: 31/10/2007 07:36:22
Mensagens: 515
Offline
|
Metodos devem ser simples de se entender, o mesmo deve acontecer com a documentação.....
|
Javai? |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 09:17:23
|
everson_z
Virtual Machine Man
![[Avatar]](/images/avatar/d240cb4a3e3d2ed5250ac2e1480422f0.jpg)
Membro desde: 05/07/2005 18:12:25
Mensagens: 568
Localização: SP - São Paulo
Offline
|
jack_-_ganzha wrote:
s4nchez wrote:Eu troco o javadoc por testes. Se o programador realmente escreveu bem o seu código, este não só será legível como existirão testes pra demonstrar na prática onde o programador queria chegar quando escreveu aquilo.
Em todos os meus últimos projetos a facilidade de entender o código era diretamente proporcional a quantidade e qualidade dos testes existentes...
Totalmente de acordo. E acho que lendo documentação vc não aprende exatamente a ler código. Ler e escrever código é que ensinam a... erhm... ler e escrever código.
valeuz...
Como funciona, vocês perguntam "O que você prefere, documentado ou bem escrito?" ?
Não pode existir os dois?
Eu sempre vejo as pessoas trocarem uma qualidade pela outra nessa forum ao invez de somar
Marck, o problema pode não ser você, já viu os programadores MacGyver que tentam programar em 500 linguagens/scripts e detonam tudo?
This message was edited 2 times. Last update was at 27/12/2007 09:20:27
|
Primeiro pensamento POG Existe casos e casos!
Segundo pensamento POG Do meu jeito é mais fácil e rápido!
Primeira merda POG Fazer as merdas que muitos fizeram por defender o primeiro pensamento POG.
Segunda merda POG Limitar o projeto ao escopo inicial.
Terceira merda POG Se basear em absurdos para defender seu desenvolvimento.
Quarta merda POG Não entender que padrão é beneficio e usar o primeiro pensamento POG.
Quinta merda POG Achar um absurdo eu escrever isso. |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 09:38:06
|
s4nchez
Virtual Machine Man
![[Avatar]](/images/avatar/bef4d169d8bddd17d68303877a3ea945.jpg)
Membro desde: 05/06/2006 11:35:55
Mensagens: 510
Localização: London, UK
Online
|
AndrewAguiar wrote:
s4nchez wrote:Eu troco o javadoc por testes. Se o programador realmente escreveu bem o seu código, este não só será legível como existirão testes pra demonstrar na prática onde o programador queria chegar quando escreveu aquilo.
Eu discordo, imaginem se o pessoal da sun seguisse esta linha de raciocínio.. acho que documentação com javadoc é extremamente importante, porém o que ocorre é que tem gente que escreve uma monografia sobre o método.
A documentação do Método deve ser simples e rápida.
Javadoc é extremamente importante para API Java, onde quem a usa tem que saber o que o método faz, sem necessariamente entender o código dele.
Agora, num projeto onde os desenvolvedores têm que saber como cada método está implementado, o cenário é outro. E neste caso me desculpe mas eu continuo preferindo testes.
Na minha opinião, para uma pessoa entender um código existente, as melhores práticas são (em ordem de eficiência):
1) Sentar com quem fez e programar em dupla
2) Executar os testes e ver como o código está sendo utilizado
3) Ler qualquer documentação em texto (javadoc, diagramas etc)
This message was edited 1 time. Last update was at 27/12/2007 09:39:02
|
Ivan Sanchez | coding dojo | blog | twitter |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 10:10:42
|
luistiagos
Forum Spammer
![[Avatar]](/images/avatar/98785ca89cfbbe933921bfe68a94553b.jpg)
Membro desde: 10/07/2006 10:37:23
Mensagens: 1699
Offline
|
coisas deste tipo são os spaguetti code ou as gambiarras nervozas... realmente e dificil mesmo entender codigos que são feitos assim e ainda não se tem comentarios... programador bom faz codigo pra ser entendido e com javadocs e comentarios para que outro entenda... e não faz spaguetis quem faz spaguete deveria e ser cozinheiro e não progrmador... bem mas isto e mais normal que vc possa imaginar... mas se olhar atentamente para um codigo e ver que eles esta descentralizado todo emaranhado cheio de gambiarra e que vc não consegue entender bulhufaz não se preucupe não e vc que e ruim e sim o "cozinheiro" ou o "magaiver(mestre das gambis)" que fez o codigo...
|
SCJP 1.5
Next Target -> SCJA 1.0 |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 10:23:00
|
jack_-_ganzha
JavaEvangelist
![[Avatar]](/images/avatar/847cc55b7032108eee6dd897f3bca8a5.jpg)
Membro desde: 31/03/2003 13:18:12
Mensagens: 315
Localização: Recife - Pernambuco
Offline
|
everson_z wrote:Como funciona, vocês perguntam "O que você prefere, documentado ou bem escrito?" ?
Não é sempre sobre somar, mas escrever e manter tralha desnecessária. Eu fico extremamente feliz quando posso deletar código ao invés de escrever mais. Se o seu código é claro o suficiente, faz sentido escrever documentação que precisa ser atualizada quando houver mudanças? No fim das contas ainda se trata de bom senso, ou você documenta gets/sets?
valeuz...
|
Marcos Silva Pereira
http://www.javafree.org
http://marcospereira.wordpress.com |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 11:26:45
|
everson_z
Virtual Machine Man
![[Avatar]](/images/avatar/d240cb4a3e3d2ed5250ac2e1480422f0.jpg)
Membro desde: 05/07/2005 18:12:25
Mensagens: 568
Localização: SP - São Paulo
Offline
|
jack_-_ganzha wrote:
everson_z wrote:Como funciona, vocês perguntam "O que você prefere, documentado ou bem escrito?" ?
Não é sempre sobre somar, mas escrever e manter tralha desnecessária. Eu fico extremamente feliz quando posso deletar código ao invés de escrever mais. Se o seu código é claro o suficiente, faz sentido escrever documentação que precisa ser atualizada quando houver mudanças? No fim das contas ainda se trata de bom senso, ou você documenta gets/sets?
valeuz...
Se houver alguma validação eu coloco no javadoc sim... Se um outro programador precisar usar, nem precisa olhar meu código pois vai estar detalhado.
Quando alguém pergunta dos meus códigos eu respondo "Olhe pelo nome da classe,o método e javadoc que é isso que vai ser feito!".
* Isso atrapalha no que?
This message was edited 1 time. Last update was at 27/12/2007 11:27:57
|
Primeiro pensamento POG Existe casos e casos!
Segundo pensamento POG Do meu jeito é mais fácil e rápido!
Primeira merda POG Fazer as merdas que muitos fizeram por defender o primeiro pensamento POG.
Segunda merda POG Limitar o projeto ao escopo inicial.
Terceira merda POG Se basear em absurdos para defender seu desenvolvimento.
Quarta merda POG Não entender que padrão é beneficio e usar o primeiro pensamento POG.
Quinta merda POG Achar um absurdo eu escrever isso. |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 27/12/2007 11:41:32
|
Marck
JavaEvangelist
![[Avatar]](/images/avatar/efc9ea3e0c2ed2c2481fe1252019266e.jpg)
Membro desde: 15/08/2006 16:15:11
Mensagens: 376
Online
|
everson_z wrote: Marck, o problema pode não ser você, já viu os programadores MacGyver que tentam programar em 500 linguagens/scripts e detonam tudo?
Complicado qd vc vê no meio do código uma chamada para um metodo q é executado no banco de dados...rs...500 linguagens em um bloco de código..rsss Bom, tomara q eu não seja "tão ruim assim"...rs... Sobre o problema q falei, as vezes encontro código com 100 linhas para fazer algo muito simples e outros q fazer coisas super complexas com 10 linhas... Outra coisa q me incomoda é qd o cara faz uma alteração e o código antigo ele deixa comentado...fica uma tralha gigante...dá pra encontrar coisa de 5 anos atrás...rs e os comentáros: "alterei pq o usuario X pediu..." ehehe [edit] Sobre javadoc não tenho q falar pois nossa linguagem é totalmente ultrapassada, mas a documentação é independente de linguagem.... [\edit]
This message was edited 1 time. Last update was at 27/12/2007 11:43:14
|
"Somos todos iguais, braços dados ou não".
Zé |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 28/12/2007 12:51:21
|
dreampeppers99
JavaChild
![[Avatar]](/images/avatar/6fb993285d56e6927284ff9b11ac6851.jpg)
Membro desde: 29/08/2006 21:50:17
Mensagens: 101
Offline
|
Marck wrote:
Pessoal,
Vcs pegam códigos que te faz passar horas e horas tentando entender o q está sendo feito?
Valores que vc nem imagina de onde estão vindo?
Eu sou mto ruim ou isso é normal?
Abraço!
Tem uma boa solução (ao menos a melhor que encontrei) para isso, refatorar...
de faz entender o código mais rapidamente... além de deixar a apossibilidade de dar mais flexibilidade ao atual sistema.
refatora um pouquinho testa, refatora um pouquinho e testa.
|
archsofty |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 28/12/2007 13:06:55
|
pardal_nb
Virtual Machine Man
Membro desde: 12/09/2006 08:26:06
Mensagens: 672
Offline
|
dreampeppers99 wrote:
Marck wrote:
Pessoal,
Vcs pegam códigos que te faz passar horas e horas tentando entender o q está sendo feito?
Valores que vc nem imagina de onde estão vindo?
Eu sou mto ruim ou isso é normal?
Abraço!
Tem uma boa solução (ao menos a melhor que encontrei) para isso, refatorar...
de faz entender o código mais rapidamente... além de deixar a apossibilidade de dar mais flexibilidade ao atual sistema.
refatora um pouquinho testa, refatora um pouquinho e testa.
citei em um dos posts acima sobre refatoracao...
mas para usar refatoracao nao eh assim tao trivial nao...é bastante aconselhavel q se tenha um conjunto de testes automatizados...nao é simplesmente "refatora um pokim, testa, refatora outro pokim e testa " ...é mais do que isso..
abraços
|
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 28/12/2007 13:17:43
|
dreampeppers99
JavaChild
![[Avatar]](/images/avatar/6fb993285d56e6927284ff9b11ac6851.jpg)
Membro desde: 29/08/2006 21:50:17
Mensagens: 101
Offline
|
pardal_nb wrote:citei em um dos posts acima sobre refatoracao...
mas para usar refatoracao nao eh assim tao trivial nao...é bastante aconselhavel q se tenha um conjunto de testes automatizados...nao é simplesmente "refatora um pokim, testa, refatora outro pokim e testa " ...é mais do que isso..
abraços
Bem eu acredito que essa "trivialidade" se dá para quem conhece o processo de refatoração...
Quando disse:
"Refatora um pouquinho, testa, refatora ...." estava resumindo (muito mesmo) o processo, ora quem quiser saber que leia.
|
archsofty |
|
|
 |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 28/12/2007 13:19:03
|
Marcio_Nogueira
Virtual Machine Man
![[Avatar]](/images/avatar/0447abe5b3fbb484f70517e8a1091b4e.jpg)
Membro desde: 21/05/2007 20:14:54
Mensagens: 923
Localização: Rio de Janeiro
Offline
|
Pior que eu? Ah, duvido!
This message was edited 1 time. Last update was at 28/12/2007 13:19:29
|
Marcio Nogueira C. Pinto |
|
|
 |
|
|