leitura de
Encontrou um problema no conteúdo? Por favor, deixe seu comentário!

1. Comentário e Documentação

Comentar o seu código está se tornando cada dia mais útil e eficiente. Seguindo os padrões corretos você pode conseguir que a sua IDE faça coisas desse tipo:

img1

Quando você passa o mouse sobre o nome de uma função ou método o IDE vai até onde ela foi definida, interpreta a sintaxe dos comentários e te traz as informações… Isso te ajuda a saber com facilidade o que a função faz, quais são os seus parâmetros e o que ela retorna… e se você estiver usando o Eclipse é só apertar F3 e ele te leva até onde essa função foi declara! Quer mais que isso?

img2



2. Indentação Consistente

Indentação é, sem dúvida, a parte mais importante desse artigo… Sem uma boa indentação o código perde toda a hierarquia de comandos… Existem várias formas de indentar o seu código, todas elas são válidas, mas algumas são mais recomendadas. Veja dois exemplos dos estilos de indentação mais utilizados:

Eu pessoalmente prefiro o primeiro estilo, pois economizamos linhas e não é tão dificil assim perceber onde começa e termina cada bloco… Há um artigo na Wikipédia que mostra os vários estilos de indentação.


3. Evite comentários óbvios

Comentar o seu código é sempre bom… Comentários só pesam no tamanho do arquivo. E não é só por isso que vamos sair comentando todas as nossas linhas… Além de duplicar (ou triplicar) o nosso tempo de desenvolvimento, nosso codigo vai ficar muito poluído e explicitar o óbivio… Vejamos alguns exemplos que não precisam nem ser comentados (literalmente):


4. Agrupamento de código

Muitas vezes fazemos isso sem perceber… E é uma ótima prática! Agrupe as linhas de código por suas funções/tarefas… Veja um exemplo:


5. Os princípios DRY, DIE e KISS

Eu me lembro desses três principios diáriamente quando estou criando código e, caso você consiga entendê-los, compreendê-los e usá-los, você vai notar uma incrivel melhoria na qualidade e eficiência do seu código. Vamos ao nome e significado de cada um:

» DRY ou Don’t Repeat Yourself (Não Se Repita) - Baseia-se no conceito de que computadores e sistemas são feitos da automação de tarefas repetitivas e o seu código não deve ser diferete… Você não deve duplicar uma linha de código pra fazer a mesma coisa!

» DIE ou Duplication Is Evil (Duplicação é malígna/má) - Segue o mesmo conceito do DRY.

» KISS ou Keep It Simple, Stupid (Mantenha-o simples, estúpido) - Determina que quanto mais simples e enxuto for seu código, melhor. Simples e rápido.

Algumas pessoas até brincando com “Dry, kiss and die”, algo como “Seque, beije e morra”… Se algum dia alguém te falar, isso, você já sabe o que fazer! :)


6. Nomes crutos para variáveis temporárias

Se você vai usar uma variável para incremento, contador ou só para armazenar um valor que será usado nas próximas linhas, ainda mais quando se trata de valores inteiros, não há necessidade de usar nomes grandes e descritivos… É muito comum usar $i, $k e $j para contadores em for/while, por exemplo.


7. Evidencie os termos especiais do SQL

Cansei de ver pessoas escrevendo consultas SQL assim:

Quando não evidenciamos os termos especiais (protegidos) fica dificil entender com facilidade o que a consulta faz… Seria muito mais produtivo fazer algo assim:

Onde as palavras protegidas do SQL são deixadas em maiúscula e os nomes de colunas e tabelas são colocados entre crases.


8. Refatoração de código

Refatorar significa mudar algo sem alterar sua funcionalidade… E refatoração de código segue a mesma lógica, se uma linha funciona bem, você pode tentar refatorá-la, reduzindo seu tamanho (KISS) melhorando sua aparencia, reutilizando códigos existentes (DRY / DIE) e manter seu real propósito.

Uma vez ouvi um profissional da área dizendo “enquanto uma linha de código não funcionar, reescreva-a… E quando ela funcionar, refatore-a até ela quase parar de funcionar novamente”.. E é mais ou menos por ai mesmo…

Espero que tenham gostado! :D

Se você estiver procurando algum material mais detalhado e técnico, recomendo a leitura do documento Walker Alencar.

Fonte: [Nettuts+](http://net.tutsplus.com/)

Thiago Belem / Blog

Thiago Belem


Publicado

Thiago Belem / Blog

Thiago Belem / Blog

Artigos e tutoriais sobre desenvolvimento WEB

Continue lendo