Repository navigation
padrao codigo
Home > Guia de contribuição do PascalRAL > Padrão de Código
-
Todas as units precisam ser concisas e referenciar um escopo, não existe necessidade de ter uma unit pra cada classe.
-
Os uses são organizados por grupo de escopo, seguindo as condições:
-
Diretivas de compilação: caso a unit dependa de outra baseada em uma condição específica, essas diretivas sempre vêm primeiro na seção uses. Caso a diretiva seja usada, precisa importar a
PascalRAL.incque contém o mapeamento das diretivas mais comuns. Caso a diretiva que você precisa não esteja inclusa lá, defina lá para usar na classe, garantindo que não seja uma redundância de outra diretiva existente. -
Units nativas da IDE: dependências presentes em todas as IDEs, tais como
Classes,SysUtils,System... -
Units da dependência: units necessárias da dependência. Ex:
ZQuery,ZComponent... -
Units do projeto: units presentes nos fontes do projeto RAL. Ex:
RALTools,RALTypes...
-
Diretivas de compilação: caso a unit dependa de outra baseada em uma condição específica, essas diretivas sempre vêm primeiro na seção uses. Caso a diretiva seja usada, precisa importar a
-
As classes precisam ser documentadas usando a notação comum de 3 barras
///seguidas da descrição resumida do método no idioma padrão Inglês americanoenUS. -
As seções internas das classes são organizadas em:
-
- Private
-
- Protected
-
- Public
-
- Published
Não informar a seção caso não precise dela
-
-
Dentro de cada seção, os atributos e métodos são classificados em ordem alfabética seguindo a ordem:
-
- Atributos internos: variáveis ou constantes
-
- Método
constructor
- Método
-
- Método
destructor
- Método
-
- Métodos:
procedureoufunction, a palavra reservada não influencia na ordem alfabética
- Métodos:
-
- Eventos: métodos que começam com “On”
-
- Atributos publicados,
property
- Atributos publicados,
-
-
A Identação padrão é a mesma definida pela IDE Delphi ou Lazarus com as seguintes alterações:
- Margem direita 90
- Diretivas seguem identação
-
As units devem ser salvas seguindo o padrão de nomenclatura do projeto: RAL + escopo da unit, por exemplo:
RALClient.Dentro da pasta relativa ao escopo de projeto, como base, utils, database… -
Os escopos de projeto atuais são:
- Base = pasta que contém as units referentes ao funcionamento mínimo do pacote e são obrigatórias na compilação para o pacote-base funcionar.
- Utils = pasta que contém funções diversas, mapeadores e demais métodos que são utilizados por várias outras units.
- Database = pasta que contém todas as units referentes ao tráfego de informações DBWare.
-
Caso o código seja para um pacote diferente, precisa ficar contido no escopo de projeto relacionado a ele, por exemplo um motor de dados possui os arquivos de projeto
.dpkdentro de\pkg\<IDE>e as units ficam em\src\engine\<motor>. Basta seguir esse modelo ou entrar em contato seja abrindo uma issue de dúvida, ou uma discussão no GitHub, ou acessando o grupo de suporte do componente.
/// Unit that represents the code that complies with documentation for contributors.
unit RALExample;
{$I PascalRAL.inc} // necessary since there's a conditional directive below
interface
uses
{$IFDEF RALWindows} Windows, {$ENDIF}
Classes, SysUtils;
type
/// Example that follows the documentation as a guideline for contributors.
TMyExample = class
private
FSomething: sometype;
public
constructor Create;
destructor Destroy; override;
/// Returns something
function GetSomething: sometype;
/// Defines something
procedure SetSomething(AParam: sometype);
/// Event to be called during something
procedure OnSomething(AParam: sometype);
property Something: sometype read GetSomething write SetSomething;
end;
implementation
[...]
end.Começar
Servidor
- Rotas e parâmetros
- Rotas avançadas: tipos, grupos, versões 🚧
- Ler o pedido e responder
- Objetos no corpo 🚧
- Resposta em fluxo 🚧
- Plugins 🚧
- Serviços (contêiner de dependências) 🚧
- Barramento de eventos 🚧
- Tarefas em segundo plano 🚧
- Recursos com estado 🚧
- Redis e Valkey 🚧
- Autenticação
- Banco de dados (DBWare)
- Servir site e arquivos
- JSON-RPC 2.0 🚧
- GraphQL 🚧
- Servidor MCP (IA) 🚧
-
Protocol Buffers 🚧
- gRPC 🚧
- WebSocket 🚧
- Hubs (WebSocket) 🚧
- SignalR 🚧
- Swagger e Postman
- Servidor SOAP 🚧
- WS-Security 🚧
- HTTPS
- Criptografia ponto a ponto
- Segurança para produção
- Colocar no ar
- Desempenho
- Testes em memória 🚧
MQTT 🚧
- O que é e quando usar 🚧
- Cliente MQTT 🚧
- Broker MQTT 🚧
- MQTT-SN 🚧
- Ponte REST 🚧
- Segurança 🚧
- Rede ruim 🚧
E-mail 🚧
- Mensagens 🚧
- Enviar 🚧
- Enviar por REST e ação 🚧
- Receber 🚧
- Ler a caixa postal 🚧
- Verificar o que chega 🚧
- Servir caixas postais 🚧
- S/MIME 🚧
- OpenPGP 🚧
Chatbot 🚧
- O robô e os canais 🚧
- Telegram 🚧
- WhatsApp oficial, Messenger e Instagram 🚧
- Gateways REST (WhatsApp não oficial) 🚧
- Discord 🚧
- Slack 🚧
- Microsoft Teams 🚧
- Conversa em etapas 🚧
Cliente
Motores
- Qual motor escolher?
- Compatibilidade
- Recursos
- QUIC
- Motor NgHttp2 (HTTP/2) 🚧
- Motor XSocket 🚧
- Motor AdvancedHTTP (experimental) 🚧
Avançado
Ajuda
- Problemas comuns
- Atualizar o Indy
- Várias versões do Delphi
- Vídeos e guias
- Módulos de terceiros
- Licenças
- Contribuir
- Roadmap e changelog
🚧 = em desenvolvimento, pode mudar