Convenções de nomenclatura na programação com ênfase em Delphi

Na programação, as convenções de nomenclatura ajudam a manter o código organizado e fácil de ler, especialmente em projetos de médio a grande porte. Vamos explorar algumas das convenções mais comuns, incluindo algumas práticas que são particularmente úteis na comunidade Delphi.

Pascal Case

  • Exemplo: MeuTesteNomenclatura
  • O Pascal case é o padrão predominante em Delphi para nomear classes, métodos e tipos de dados. Em Delphi, usamos Pascal case para identificar componentes e classes como TFormCliente, TProduto, CalcularImposto, etc. Essa convenção segue as diretrizes recomendadas para um código mais legível e organizado.
  • Também conhecido como: Upper Camel Case e Capital Case

Camel Case

  • Exemplo: meuTesteNomenclatura
  • No camel case, o nome da variável começa com letra minúscula, e as palavras seguintes iniciam com letra maiúscula. Essa convenção não é muito utilizada em Delphi, mas pode aparecer em alguns contextos, especialmente para métodos em frameworks específicos.
  • Também conhecido por: Lower Camel Case e Dromedary Case

Snake Case

  • Exemplo: meu_teste_nomenclatura
  • No snake case, todas as palavras se iniciam com letras minúsculas, e as palavras são separadas por um Underline. Em Delphi, o snake case não é comum, mas pode ser usado para constantes em módulos específicos ou para convenções internas em variáveis de configuração. É mais frequentemente visto em nomes de constantes globais, mas o Pascal case geralmente é preferido.
  • Também conhecido como: Underscore Case

Screaming Snake Case

  • Exemplo: MEU_TESTE_NOMENCLATURA
  • Esta convenção, onde todas as letras estão em maiúsculas e separadas por underscores, é comum para constantes globais. Em Delphi, é usada para definir valores constantes ou identificadores fixos, como MAX_LINHAS ou TOTAL_USUARIOS. Isso facilita a distinção visual de constantes em relação a variáveis comuns.

Kebab Case

  • Exemplo: meu-teste-nomenclatura
  • Aqui todas as letras são minúsculas e as palavras são separadas por hifens. Kebab case não é utilizado em Delphi, uma vez que o uso de hifens em nomes de variáveis e métodos não é permitido. Ele é mais comum em contextos fora do código-fonte, como nomes de arquivos ou URLs.
  • Também conhecido como: Spinal Case, Dash Case ou Lisp Case

Screaming Kebab Case

  • Exemplo: MEU-TESTE-NOMENCLATURA
  • O screaming kebab case, com todas as palavras em maiúsculas e separadas por hifens, também não é aplicável no Delphi para nomes de variáveis ou métodos, devido ao uso restrito de hifens. No entanto, essa convenção pode aparecer em nomes de arquivos ou configurações externas para indicar seções importantes ou parâmetros configuráveis de destaque.

Notação Húngara

  • Exemplo: strNome para uma string contendo um nome, intIdade para um inteiro representando idade.
  • Embora menos popular em linguagens modernas, a notação Húngara ainda aparece em Delphi, especialmente em código legado ou em projetos que seguem uma metodologia de padronização de tipos nas variáveis. A notação Húngara facilita a identificação do tipo de variável diretamente pelo nome. Essa prática ajuda a entender rapidamente o propósito e o tipo das variáveis no código, sendo útil em contextos específicos.

Tabela de Convenções, Exemplos e Locais de Uso

ConvençãoExemploLocais de Uso
Camel CasemeuTesteNomenclaturaVariáveis locais em alguns frameworks específicos
Pascal CaseMeuTesteNomenclaturaNomes de classes, métodos e tipos de dados
Snake Casemeu_teste_nomenclaturaConstantes internas e variáveis de configuração
Screaming Snake CaseMEU_TESTE_NOMENCLATURAConstantes globais
Kebab Casemeu-teste-nomenclaturaNão utilizado em código Delphi; aplicável em nomes de arquivos e URLs
Screaming Kebab CaseMEU-TESTE-NOMENCLATURANomes de arquivos e configurações externas
Notação HúngarastrNome, intIdadeCódigo legado e projetos que exigem tipificação explícita
Flat CaseflatcaseTodas as letras são minúsculas, sem espaços ou separadores. Não é comum o seu uso no Delphi.
Upper Flat CaseUPPERFLATCASETodas as letras são maiúsculas sem espaços ou separadores. Não é comum o seu uso no Delphi.
Camel Snake Casecamel_Snake_CaseCombinação das regras de snake case e camel case. Não é comum o seu uso no Delphi.
Pascal Snake CasePascal_Snake_CaseCombinação de snake case e pascal case. Não é comum o seu uso no Delphi.
Train CaseExemplo-De-Train-CaseVariação do Kebab Case ao usar o hífen como separador, mas com as primeiras letras de todas as palavras sempre em maiúsculas. Não é comum o seu uso no Delphi.

Convenções em Delphi: Padrões e Consistência

Delphi tem uma longa tradição em seguir convenções de Pascal case para tipos e classes, com constantes geralmente em snake case ou screaming snake case. Para quem trabalha com Delphi, adotar esses padrões facilita a manutenção e a compreensão do código, além de promover uma linguagem visual consistente para os desenvolvedores.

Para mais informações sobre nomenclaturas e convenções em Delphi, consulte o Style Guide do Delphi.

Por fim, vale lembrar que manter a consistência é fundamental em qualquer projeto, independentemente das convenções escolhidas.

Curtiu a postagem? Então, não se esqueça de deixar seu comentário e compartilhar! Abraço e até a próxima.