Convenções de Código

Convenções do Projeto

Para garantir a consistência e a legibilidade do código em todo o projeto, adotamos as seguintes convenções de código:

1. Documentação de Código: Cada arquivo .inc deve conter um cabeçalho com a descrição das funções incluídas no arquivo. Por exemplo:

/**
 * [Commands for SpawnGroups]
 * LoadQuestData() - Get the DataFile document
 * SetSpawnGroupData(group_name, group_struct) - Set changes to a group;
 * GetSpawnGroupData(group_name) - Get all info about a group;
 * RemoveGroupData(group_name) - Remove a group;
 * RemoveGroupMobData(group_name, index_mob) - Remove a mob from mobList. Need index;
 * UpdateGroupMobData(group_name, mob_struct, index) - Update all informations about a mob.
 */

2. Nomenclatura de Funções: Os nomes das funções devem ser intuitivos e refletir o tipo de retorno da função. Por exemplo:

// A função retorna um valor booleano
// Correto:
isUserFrozen() // return true

// Errado:
userFrozen() // return true

3. GUMP IDs: Ao implementar novos Gumps, certifique-se de que cada Gump tenha seu próprio GUMP ID. O ID do gump deve ser especificado na constante de GUMPS em scripts/include/client.inc.