Convenções de nomenclatura
A seguir, apresentamos algumas das convenções mais comuns utilizadas na comunidade de Solidity:
Contratos: Os nomes de contratos geralmente seguem o formato UpperCamelCase (também conhecido como PascalCase). Cada palavra no nome do contrato começa com uma letra maiúscula e não há espaços. Exemplo:
MySmartContract.Funções: Os nomes de funções geralmente seguem o formato lowerCamelCase. A primeira palavra começa com uma letra minúscula, e as palavras seguintes começam com uma letra maiúscula. Exemplo:
myFunction.Variáveis de Estado: As variáveis de estado também usam o formato lowerCamelCase. Estas são as variáveis armazenadas permanentemente no armazenamento do contrato. Exemplo:
myVariable.Variáveis Locais e Parâmetros: Assim como as variáveis de estado, as variáveis locais e os parâmetros das funções também utilizam lowerCamelCase. Exemplo:
localVariable,functionParameter.Constantes: As constantes são nomeadas com todas as letras em maiúsculas, e as palavras são separadas por sublinhados (snake_case em maiúsculas). Exemplo:
MAX_COUNT,TOTAL_SUPPLY.Enums: Os nomes de enumeradores (enums) seguem o formato UpperCamelCase, assim como os nomes de contratos. Exemplo:
TokenState.Eventos: Os eventos geralmente seguem o formato UpperCamelCase. Exemplo:
TransferCompleted.Modificadores: Os modificadores utilizam o formato lowerCamelCase, semelhante às funções. Exemplo:
onlyOwner.Structs: Os nomes de estruturas (structs) são geralmente escritos em UpperCamelCase, seguindo o mesmo padrão de contratos e enums. Exemplo:
PlayerInfo.
Observação:
Essas convenções não são obrigatórias, mas são amplamente adotadas pela comunidade de desenvolvimento de Solidity. Seguir essas práticas padrão ajuda a manter o código dos contratos inteligentes organizado e fácil de entender para outros desenvolvedores que possam trabalhar ou revisar o código. Além disso, essas convenções ajudam a distinguir rapidamente os diferentes tipos de entidades no código, como contratos, funções e variáveis.
Last updated