A Embarcadero acaba de publicar no site docwiki uma versão atualizada do guia de estilo de linguagem. O documento foi atualizado para cobrir os recursos modernos da linguagem Delphi e algumas mudanças no estilo de codificação
Nos últimos meses, fiz um esforço para publicar um novo guia de estilo Object Pascal para a linguagem Delphi de hoje. Do prefácio:
“Este documento é uma versão atualizada do guia de estilo clássico Object Pascal, originalmente com curadoria de Charlie Calvert para a Borland na época em que o Delphi foi originalmente lançado. A versão atualizada foi selecionada pelo gerente de produto da Delphi, Marco Cantu, com contribuições da equipe interna de P&D, MVPs da Delphi e da comunidade Delphi em geral. ”
O texto não é um guia de linguagem, em vez disso, cobre o uso de espaços em branco e formatação ao escrever o código – algo que o compilador geralmente ignora. Nada é obrigatório aqui, esta é apenas uma recomendação para favorecer a legibilidade. Seguir essas regras é um requisito para nossa própria equipe interna e para qualquer colaborador.
Você pode encontrar o guia de estilo em http://docwiki.embarcadero.com/RADStudio/Sydney/en/Delphi’s_Object_Pascal_Style_Guide .
Este é o índice do documento:
- Introdução
- Regras gerais: identificadores, palavras-chave, recuo
- Arquivos de código-fonte, unidades e sua estrutura
- Uso de espaço em branco
- Comentários
- Afirmações
- Declarações de tipo
Vou terminar este blog postando uma breve introdução:
Enquanto os compiladores Delphi geralmente ignoram qualquer espaço em branco e permitem muita flexibilidade na forma como um desenvolvedor escreve o código, para legibilidade e manutenção do código-fonte, a Embarcadero definiu um conjunto de diretrizes usadas pelo P&D interno e qualquer desenvolvedor envolvido com o projeto. Recomendamos que a comunidade Delphi em geral adote esse estilo de codificação e formatação.
A introdução da versão original deste documento expressa isso muito bem:
“Object Pascal é uma linguagem lindamente projetada. Uma de suas grandes virtudes é a legibilidade. Esses padrões são projetados para melhorar a legibilidade do código Object Pascal. Quando os desenvolvedores seguem as convenções simples apresentadas neste guia, eles estão promovendo padrões que beneficiam todos os desenvolvedores Delphi, usando um estilo uniforme e fácil de ler. Os esforços para fazer cumprir esses padrões aumentarão o valor do código-fonte do desenvolvedor, especialmente durante os ciclos de manutenção e depuração. ”
Este documento não faz referência ou explica a sintaxe e a gramática da linguagem, pois se concentra apenas na definição do estilo de escrita do código em locais onde a linguagem oferece uma escolha, permitindo muitas opções diferentes em termos de espaço em branco e formatação.
Nenhuma dessas diretrizes é imutável e esperamos que evoluam com o tempo junto com a linguagem.
Design. Code. Compile. Deploy.
Start Free Trial Upgrade Today
Free Delphi Community Edition Free C++Builder Community Edition
