Padrão de escrita ou Legibilidade de código

Como no artigo anterior acabei falando um pouco sobre padrão de escrita de variavel e objetos, gostaria de ir um pouco mais a fundo sobre isso.

O que é Padrão de escrita ou Legibilidade de código?

Padrão de escrita ou legibilidade de código é a facilidade de se escrever um código seguindo alguns padrões ou notações, para se ter um código mais claro e fácil de se interpretar.
Esta maneira de se escrever não é muito utilizada por programadores iniciantes, mas é de grande utilidade e importância.


Notação húngara

A Notação húngara, criada por Charles Simonyi, visa a facilitar o reconhecimento do tipo de variável em um programa. O nome foi dado a partir de uma brincadeira comum entre aqueles primeiros a conhecer a notação e a achavam estranha, fazendo o seguinte comentário: "É tão estranho que até parece húngaro".

A tabela abaixo indica os tipos de indicadores mais utilizados na Notação húngara:

s - String
sz - Aponta o primeiro caracter da terminação zero da string
st - Ponteiro da string, o primeiro byte é contado dos caracteres
h - handle (título)
msg - Message
fn - function (usada com pointer)
c - char (8 bits)
by - unsigned char (byte or uchar - 8 bits)
n - Int
b - Boolean (verdadeiro ou falso)
f - Flag (boolean, logical). Se qualificado é usado, pode descrever o estado verdadeiro do flag. Exceção às constantes.
u - integer
w - Word
ch - Char, com texto ASCII
l - long int (32 bits)
dw - unsigned long int (dword - 32 bits)


Padrão próprio

É comum em algumas empresas utilizarem padrões próprios para escrita de nomes de objetos e variaveis.

Estive pesquisando um pouco sobre este assunto na internet e encontrei algumas idéias para se criar um padrão próprio.


Nomes em inglês

Utilização de Nomes de variaveis, objetos e funções ou qualquer texto que se posso utilizar na nomeação de um código em inglês.

Particularmente eu não utilizo o inglês por estar trabalhando no Brasil e assim achar o entendimento em português mais fácil, dessa maneira também não confundimos os nomes que criamos com comandos ou funções da linguagem, mas mesmo assim não deixa de ser interessante a escrita em inglês, principalmente em uma empresa que atua também no exterior.

Tabulação

Na minha opnião, extremamente importante para o entendimento do código. A tabulação ajuda a "encaixar" a programação de forma que você consegue visualizar o que esta dentro do que, por exemplo uma instrução IF que possui um certo código na sua condição e um outro IF com outras instruções dentro, como você separaria tudo isso, se não utilizasse tabulação? O seu código sem tabulação ficaria uma "linguiça", como diria um professor meu.

Criando um padrão

Vamos agora então criar um padrão para a escrita do seu código. Geralmente eu utilizo as 3 primeiras letras do tipo de objeto/variavel, como a seguir:

str: String
int: Integer
dbl: Double
lbl: Label
txt: Texto

e assim por diante...

Logo depois do tipo eu coloco o nome, ai então podemos utilizar duas maneiras: Com separação de palavras ou sem separação de palavras.

Com separação de palavras

Geramente é utilizado para separar palavras o caracter underline "_", por exemplo: lblNome_Empresa.

Sem separação de palavras

Acredito que este tipo de escrita é o mais utilizado hoje, é feita da seguinte forma:

Ex: lblNomeEmpresa.

Bom desenvolvimento a todos!