Skip to content

Instantly share code, notes, and snippets.

View douglasconstancio's full-sized avatar
:shipit:
*tec tec tec noises*

Douglas Constancio douglasconstancio

:shipit:
*tec tec tec noises*
View GitHub Profile

AdvPL Coding Standards

O presente documento tem por objetivo estabelecer um padrão de boas práticas a serem utilizadas pelas equipes de Desenvolvimento NG que atuam na plataforma Protheus AdvPL. As regras aqui listadas não são restritivas, mas buscam estabelecer uma identidade única para os fontes. A adoção desse padrão deve naturalmente se tornar um hábito, aumentando a legibilidade dos fontes e proporcionando mais segurança no processo de manutenção de sistemas.

Novas funções devem ser desenvolvidas considerando as boas práticas listadas, e funções já existentes devem ser adequadas gradativamente. Entretanto não se recomenda a mudança de trechos que não fazem parte do escopo de alteração, de forma a não comprometer a revisão técnica do fonte nem gerar risco de inserção de novos bugs acidentalmente.

Arquivo

  • A extensão deve ser minúscula (exemplo: .prw, .apw)

Anti-patterns e código limpo


Conceitos

Quando se fala em desenvolvimento de software é comum ouvirmos sobre design patterns, ou padrão de projeto, que nada mais é do que uma solução geral para um problema que ocorre com frequência dentro de um determinado contexto no projeto de software. Assim, um anti-padrão é:

[...] um padrão de projeto de software que pode ser comumente usado, mas é ineficiente e/ou contra-produtivo em prática.

Anti-patterns

Business Rules - Service request

Neste documento será apresentado a regra de negócio relacionada às entidades de solicitação de serviço que devem ser aplicadas no sistema Keepfy.

O Campo de branch define o registro de maneira que em todas as entidades JAMAIS deve ser alterado.


Solicitação de Serviço

  • Abertura

Business Rules - Service order, inputs and steps

Neste documento será apresentado a regra de negócio relacionada às entidades de ordem de serviço, insumos e etapas, que devem ser aplicadas no sistema Keepfy.

O Campo de 'branch' define o registro de maneira que em todas as entidades JAMAIS deve ser alterado.


Ordem de Serviço

  • Abertura

Business Rules - Basic registrations

Neste documento será apresentado a regra de negócio dos cadastros gerais e que devem ser aplicadas no sistema Keepfy.

O Campo de 'branch' define o registro de maneira que em todas as entidades JAMAIS deve ser alterado.


Área

  • Inclusão