Programação
Referenciado por: Dicas Técnicas | Predefinição:Guia de Programação Banco de Dados | Guia para Atualização de Metadados do Totali Commerce | Guia para Exportação para Checkout do Totali Commerce | Guia para Manutenção de Estrutura do Totali Commerce | Guia para Manutenção de Functions e Procedures do Totali Commerce | Guia para Manutenção de Packages do Totali Commerce | Guia para Manutenção de Triggers do Totali Commerce | Guia para Manutenção de Views do Totali Commerce | Introdução a Programação de Banco do Totali Commerce |
| Guia de programação para linguagem de banco | |
| Introdução | |
| Padrões Gerais | |
| Estrutura | |
| Exportação para Checkout | |
| Metadados | |
| Views | |
| Functions | |
| Triggers | |
| Packages |
Esse artigo define alguns padrões para programação em PL/SQL (linguagem procedural do Oracle) e PL/PGSQL (do PostgreSQL).
Codificação dos Arquivos
Utilizar Codificação em ANSI (padrão Windows).
Isto porque nós trabalhamos em um ambiente Windows.
Tabulações
Utilizar espaços no lugar das tabulações.
No notepad++ configurar em Configurações >>> Preferências >>> Tab Settings para utilizar espaços para fazer tabulação.
Como deve ficar
Como não pode ficar
Como fica no notepad++
Nomenclatura do Arquivo
Pode variar de acordo com o objeto que se está criando. Confira cada regra em cada artigo específico.
Extensão dos arquivos de macro
Extensão em minúsculo ".mac".
Como nós utilizar macros para unificar algumas formas de programas entre o PL/SQL e o PG/PLSQL, a extensão do arquivo deve ser ".mac" - de macro.
Tipografia do fonte
Caixa alta, exceto:
- Prefixo de variáveis.
- Nome de variáveis que não sejam colunas de banco.
- Nome de Funções.
Nome da variável
CamelCase - "sem underlines". E com prefixo significativo. Quando se tratar de um nome de coluna ou uma sigla devemos utilizar caixa alta.
Exemplos válidos:
- cCODFIL
- bErro
- nValorDummyIPI
- aTT_REC
Vamos abandonar o uso de WK e V como prefixos.
| Tipo | Nome da variável |
| NUMBER | nValorExemplo |
| CHAR/VARCHAR | cDescricaoExemplo |
| DATE | dDataExemplo |
| BOOLEAN | bSeExemplo |
| ARRAY | aArrayExemplo |
| ROWTYPE ou REGISTER | rRegistroExemplo |
Indentação
3 espaços.
Apesar de a indentação com 2 espaços ser bastante utilizada, é possível encontrar trechos de código na documentação oficial do Oracle que não respeitam essa regra. Além disso, fontes complexos ficam bem difíceis de ler. Por isso, utilize 3 espaços, inclusive no começo da função e na declaração de variáveis.
Exemplo:
DECLARE nValorExemplo NUMBER(12,2); dATU_EM TT_VEN.ATU_EM%TYPE; BEGIN nValorExemplo := 1; IF nValorExemplo = 1 THEN bSeExemplo := TRUE; ELSE bSeExemplo := FALSE; END IF; dATU_EM := Agora();
Alinhamento na declaração de variáveis
Tipos na coluna 34.
Os tipos devem estar na coluna 34 para permitir o alinhamento vertical dos tipos, e ainda reservar um bom tamanho para declarações de variáveis.
Um nome de variável que não cabe nesse espaço é grande demais.
