Não deixe seu código bagunçado

Quando desenvolvemos um projeto de TI, que seja via desenvolvimento de software é importante que todo o código seja bem indentado, ou seja alinhando de forma correta.

Quando estamos desenvolvendo um projeto maior, com algumas pessoas programando, é importante a definição de um padrão de indentação, esse padrão deve ser documentado, deve esta escrito em algum endereço/lugar que todos programadores tenham acesso, é importante que todos sigam o padrão, e que não seja possível notar de foi o programador A ou o B que fez aquela código, só de olhar pra ele.

A palavra indentação não existe no português é um neologismo, uma “abrasileração” de indentation em inglês, recuo.

Segue um exemplo de um código não indentado (em PHP, mas a idéia vale para qualquer linguágem)

public function teste( $valor )
{
minhaFuncao();
if ( $valor )
{
$valor = 'meuValor';
for ($i =0 ; $i <10 ; $i++ )
{
echo $i;
}
}
}

Segue um exemplo de código indentado (em PHP):

public function teste( $valor )
{
    minhaFuncao();
 
    if ( $valor )
    {
        $valor = 'meuValor';
 
        for ($i =0 ; $i <10 ; $i++ )
        {
             echo $i;
        }
 
    }
 
}

Você irá concordar que o código indentado é muito mais legível, apesar de neste caso o código não indentado também ser em um grande projeto, com vários arquivos e milhares de linhas de código, pode ficar confusa a leitura.

Vale citar que algumas linguagens, a exemplo do Python, exigem indentação correta para funcionar/compilar.

É importante também que os editores/IDES devem ser configurados, todos da mesma forma, para facilitar a geração do código indentado. Como dica: não utilizem tabulação real, troquem tab por espaço, no editor de textos.

Cada vez mais é importante ter este tipo de cuidado com o nosso querido código fonte, que no meu caso, é o ganha pão, padronização com intenção de melhorar a manutenibilidade, ou seja capacidade de manutenção do código.

Fica uma imagem para reflexão:

Abração a todos!