O grande problema em programação é que cada um faz de um jeito. A bem da verdade, entre um POG e outro, o programador deia sua marca no código fonte. E isso as vezes pode ser um problema para seus companheiros. Códigos desorganizados, variáveis com nomes estranhos, seqüencias em uma única linha, e um verdadeira confusão em algorítimos que ninguém, as vezes nem mesmo o criador, sabe explicar para que aquilo serve.
Em virtude disso, sem nenhum local centralizador, um código de boa conduta, passado de boca em boca, com a experiência dos Seniores surgiu, completamente desorganizado, assim como o código fonte de seus criadores, mas ele não passa se um apanhado de regras simples e intuitivas sobre como deixar seu código fonte um broto:
#1 – Comente meu Rapaz.
Comentar é uma maravilha moderna! Algo que as mulheres fazem muito bem! Comentar o código é o que devemos fazer, quanto mais melhor! Criou uma Procedure nova? Explica o milagre que ela faz! Aquele trecho meio satânico do código então. Use 20 linhas para descrever a lógica dele! Faça do seu POG um manual. Assim, até mesmo você saberá o que ele faz.
#2 – Mantenha as coisas bonitas.
Quanto mais bonito, mais organizado, mais fácil de entender. A não ser que você tenha ótimos motivos para criar um código confuso, trabalhoso, duro, penoso, e chato de ler, entender e acompanhar. Mantenha seu código limpo.
#3 – Identação.
Você sabe usar a tecla TAB? Então use-a! Identar um código fonte é ótimo para não se perder, não esquecer de fechar condicionais, loops e até mesmo o próprio código fonte, e para variar, deixa tudo mais organizado, mais limpo, mais agradável aos olhos. Simplesmente faça, alinhe os códigos com espaçamento de acordo com o início de uma função, condicional, loop, contador, ou seja lá o que você for fazer! Alinhe e respeite sempre a hierarquia da coisa!
#4 – Espaçamento entre os objetos.
Assim como o TAB, a barra de espaço é uma grande amiga! Use-a para separar as coisas, fórtumas matemáticas, virgulas, variáveis, e o que vc estiver com vontade de separar. Escrever tudo grudado em uma única linha é algo que vai deixar qualquer um puto por ter que futuramente efetuar a manutenção do seu código.
#5 – Quebra de Linha.
Isso mesmo, nada de escrever linhas extensas, compridas e cheia de coisas, use o ENTER!
Quebra de linhas tornam a leitura mais rápida e eficiente! Acredite, é realmente ruim ter que deslizar a barra de rolagem inferior. Evite ao máximo isso! Use quebra de linha
#6 – Nomeie Corretamente
Variável, constante, procedure, módulo, função, seja lá o que você for criar, apenas nomeie de um jeito que seja possível ter uma noção do que aquilo faz, ou até mesmo você vai se esquecer,
#7 – Funções “Faz Tudo”
Okay, se você fez alguma função desse tipo... Pare de ler agora e abandone a vida de programador.
Nenhuma função faz de tudo. Isso só serve para deixar seu código confuso, pesado e cheio de coisa inútil. Crie funções específicas, que resolver um tipo de problema. O resto você pensa depois, cria outra função. E não esqueça de comenta-las.
#8 – Siga uma convenção de nomenclaturas, ou crie a sua
De nomes de acordo com o objetivo da função, variável, constante, etc... se for um inteiro inicie o nome com “int”, se for do tipo double “dbl” de depois de o nome padrão para a coisa em sí. Isso auxilia a saber de que classe aquele objeto pertence. Outros Exemplos são “btn” para botões, “lbl” para Label e assim por diante.
#9 – Go To( )
Nunca, nunca em toda a sua vida use essa função ou algo similar! Mantenha seu código linear, estruturado, caso esteja usando uma linguagem estruturada, não tente criar orientação em linguagens que não foram criadas para isso! O contrário também é valido. Se você está programando de maneira orientada a objetos, ou seja lá o que for. Siga isso a risca! Jamais misture as coisas!
Referências :
http://www.ibm.com/developerworks/aix/library/au-hook_duttaC.html
http://www2.eletronica.org/artigos/eletronica-digital/programando-em-c-boas-praticas
http://javafree.uol.com.br/artigo/871700/Aprendese-a-programar-bem-sabendo-o-que-nao-se-deve-fazer.html
http://msdn.microsoft.com/pt-br/library/cc580565.aspx
Em virtude disso, sem nenhum local centralizador, um código de boa conduta, passado de boca em boca, com a experiência dos Seniores surgiu, completamente desorganizado, assim como o código fonte de seus criadores, mas ele não passa se um apanhado de regras simples e intuitivas sobre como deixar seu código fonte um broto:
#1 – Comente meu Rapaz.
Comentar é uma maravilha moderna! Algo que as mulheres fazem muito bem! Comentar o código é o que devemos fazer, quanto mais melhor! Criou uma Procedure nova? Explica o milagre que ela faz! Aquele trecho meio satânico do código então. Use 20 linhas para descrever a lógica dele! Faça do seu POG um manual. Assim, até mesmo você saberá o que ele faz.
#2 – Mantenha as coisas bonitas.
Quanto mais bonito, mais organizado, mais fácil de entender. A não ser que você tenha ótimos motivos para criar um código confuso, trabalhoso, duro, penoso, e chato de ler, entender e acompanhar. Mantenha seu código limpo.
#3 – Identação.
Você sabe usar a tecla TAB? Então use-a! Identar um código fonte é ótimo para não se perder, não esquecer de fechar condicionais, loops e até mesmo o próprio código fonte, e para variar, deixa tudo mais organizado, mais limpo, mais agradável aos olhos. Simplesmente faça, alinhe os códigos com espaçamento de acordo com o início de uma função, condicional, loop, contador, ou seja lá o que você for fazer! Alinhe e respeite sempre a hierarquia da coisa!
#4 – Espaçamento entre os objetos.
Assim como o TAB, a barra de espaço é uma grande amiga! Use-a para separar as coisas, fórtumas matemáticas, virgulas, variáveis, e o que vc estiver com vontade de separar. Escrever tudo grudado em uma única linha é algo que vai deixar qualquer um puto por ter que futuramente efetuar a manutenção do seu código.
#5 – Quebra de Linha.
Isso mesmo, nada de escrever linhas extensas, compridas e cheia de coisas, use o ENTER!
Quebra de linhas tornam a leitura mais rápida e eficiente! Acredite, é realmente ruim ter que deslizar a barra de rolagem inferior. Evite ao máximo isso! Use quebra de linha
#6 – Nomeie Corretamente
Variável, constante, procedure, módulo, função, seja lá o que você for criar, apenas nomeie de um jeito que seja possível ter uma noção do que aquilo faz, ou até mesmo você vai se esquecer,
#7 – Funções “Faz Tudo”
Okay, se você fez alguma função desse tipo... Pare de ler agora e abandone a vida de programador.
Nenhuma função faz de tudo. Isso só serve para deixar seu código confuso, pesado e cheio de coisa inútil. Crie funções específicas, que resolver um tipo de problema. O resto você pensa depois, cria outra função. E não esqueça de comenta-las.
#8 – Siga uma convenção de nomenclaturas, ou crie a sua
De nomes de acordo com o objetivo da função, variável, constante, etc... se for um inteiro inicie o nome com “int”, se for do tipo double “dbl” de depois de o nome padrão para a coisa em sí. Isso auxilia a saber de que classe aquele objeto pertence. Outros Exemplos são “btn” para botões, “lbl” para Label e assim por diante.
#9 – Go To( )
Nunca, nunca em toda a sua vida use essa função ou algo similar! Mantenha seu código linear, estruturado, caso esteja usando uma linguagem estruturada, não tente criar orientação em linguagens que não foram criadas para isso! O contrário também é valido. Se você está programando de maneira orientada a objetos, ou seja lá o que for. Siga isso a risca! Jamais misture as coisas!
Referências :
http://www.ibm.com/developerworks/aix/library/au-hook_duttaC.html
http://www2.eletronica.org/artigos/eletronica-digital/programando-em-c-boas-praticas
http://javafree.uol.com.br/artigo/871700/Aprendese-a-programar-bem-sabendo-o-que-nao-se-deve-fazer.html
http://msdn.microsoft.com/pt-br/library/cc580565.aspx
Um comentário:
Rapha, use o span class="fullpost", ok?
Postar um comentário