Boa tarde, pessoal.
Existe alguma regra quanto ao uso do T no início de classes em AdvPL ou TLPP? Percebo que muitas classes padrões da TOTVS utilizam essa nomenclatura, mas apenas as desenvolvidas pelo time da TEC, enquanto o Framework utiliza Fw.
O T é apenas um padrão seguido pela TOTVS nas ferramentas da TEC ou existe alguma regra/legado/boa prática quanto a isso?
Grato.
Olá,
O T normalmente é utilizado pelo binário do Protheus, assim como o FW é comumente utilizado pelo Framework, logo, ambos devem ser evitados.
Quanto a padronização, existe uma documentação da Engenharia do Protheus sobre isso para fontes TLPP:
https://tdn.totvs.com/pages/releaseview.action?pageId=633537898
Estou utilizando essa cola:
| Tipo | Padrão | Exemplo |
|---|---|---|
| Classes | PascalCase | ClientePremium |
| Funções | camelCase | RepositorioDados |
| Métodos | camelCase | calcularDesconto() |
| Variáveis | camelCase | idadeCliente |
| Constantes | UPPER_CASE | TAXA_DESCONTO |
| Fontes Totvs | .<agrupador/serviço>. | backoffice.tgv.contact.controller.tlpp manufacturing.material.balance.tlpp |
| Fontes Customizados | iniciar com valor fixo custom e o restante é livre nomes em minúsculo e sem underscore (sublinhado) |
custom.cadastros.cliente.tlpp custom.ma030inc.tlpp |
Padronização:
Classes - cada palavra começa com maiúscula, sem separação
Class ContactsController
Motivo: melhorar a legibilidade.
Funções e Métodos - primeira palavra minúscula, palavras seguintes iniciam com maiúscula)
Function contactsController()
Method validName() Class ContactsController
Motivo: Diferenciar de classes e manter a legibilidade
É válido ressaltar que o uso de case (Upper, Pascal, Camel) no ADVPL/TLPP é apenas estético, o ADVPL não é case sensitive.