Melhorar a legibilidade do Código em programação

A função do código não é só ser compilado/interpretado pelo computador, este também tem que ser lido pelo(s) autor(es) ou por outras pessoas. Assim sendo, é importante escrever um código que seja fácil de entender. De que formas?

 

A Make It Digital preparou 6 Dicas MID sobre os pontos principais a ter em conta quando trabalha em Código

 

  1. Indentação (espaçamento)

A indentação é opcional na maioria das linguagens programação, servindo apenas para a legibilidade. Uma boa indentação é útil para identificar imediatamente, por exemplo, que determinado código deve correr, no caso de uma condição ser cumprida ou uma função executada.

 

  1. Nomes com significado

O nome das variáveis, funções, classes, etc, é a primeira forma de perceber o seu propósito entre o código. Uma variável de nomes “p1” e “p2” são mais difíceis de entender do que “price” e “salePrice”.

 

  1. Diferenciar várias palavras

Uma variável bem descrita é boa, mas se tiver várias palavras pegadas pode ser difícil de entender. É boa prática separar as palavras com maiúsculas (camelCase ou PascalCase) ou, por exemplo, com underscores (underscore_case).

Exemplificando, priceWithoutTax é muito mais legível do que pricewithouttax.

 

  1. Não juntar demasiadas funções/operações na mesma linha

Para identificar melhor cada parte do código, é aconselhado separar processos em múltiplas linhas, e realizar um passo de cada vez. Depois usa-se o resultado de todas as partes de uma forma muito mais clara.

 

  1. Comentários

Mesmo com bons nomes de variáveis e funções, é possível que partes do código sejam pouco claras por si só. Por exemplo, quando se divide uma variável por 100 não é necessário repetir, em comentário, que se está a fazer a operação de divisão, mas pode ser relevante indicar que o valor da variável estava em percentagem.

 

  1. Coerência

É importante ser coerente na escrita do código. Isto é, as regras anteriores deverão ser aplicadas da mesma forma em todo o script/biblioteca/etc.
A linguagem de programação também é um factor, a mesma altera o que é “aceite” e o que não é. Tanto que há linguagens que têm uma ou mais guias próprias para a forma (visual e não só) de escrever código. São exemplos a PEP8 para Python e a PSR-2 para PHP.

 

Aqui está um exemplo prático de tudo o que foi referido anteriormente:

 

Exemplo de código

 

A Make It Digital preparou estas 5 Dicas/Expressões muito utilizadas em programação/IT. Estas são algumas praticas de código utilizadas pelos especialistas de IT da MID. Para mais informações basta contactar a Make It Digital e deixar a magia acontecer.

Contact Us

We're not around right now. But you can send us an email and we'll get back to you, asap.

Abrir Chat
Podemos ajudar? Estamos no WhatsApp
Olá! Podemos ajudar? :)