1. Convenções de Nomes

Conteúdo

1.1 Regras Gerais
1.2 Convenções Usadas
1.3 Nomes de Arquivos
1.4 Nomes de Variáveis
1.5 Nomes de Classes
1.6 Nomes de Atributos
1.7 Nomes de Métodos

1.1 Regras Gerais

Escolha nomes descritivos. Evite abreviações.

1.2 Convenções usadas

1.2.1 Camel Case
Inicia-se com letra mínuscula, cada nova palavra se inicia com letra maíscula.
Ex:
darkMage
longSword
mana

1.2.2 Pascal Case
Cada palavra se inicia com letra maíuscula.
Ex:
HandleInput
LoadTexture
Open

1.3 Nomes de Arquivos

Pascal Case
Ex:
ArquivoExemplo.h
ExemploUtilizado.cpp

Atenção! Não utilizar espaços em nomes de arquivo!

MinhaClasse.h Correto
Minha Classe.h INCORRETO

1.4 Nomes de Variáveis

Variáveis, parâmetros de funções e métodos e campos de struct devem ser escritos em Camel Case, exceto constantes, que devem ser escritas com letras maísculas.

Ex. 1

int manaPoints;
const float PI = 3.14;

Ex. 2

void PlaySound(std::string fileName) {
...
}

Ex. 3

struct Sword {
   int attackPoints;
   float durability;
};

1.5 Nomes de Classes

Pascal Case

class Foo {
};

1.6 Nomes de Atributos

1.6.1 Atributos públicos
A princípio não existirão.

1.6.2 Atributos privados Nomes de atributos privados iniciam com prefixo "_", seguidos de notação Camel Case.
Ex:

class Vector {
   float _x;
   float _y;
};

1.7 Nomes de Métodos

Pascal Case
Ex:

class Hero {
public:
   void StrongAttack();
   void Jump();
};

Getters e setters devem ser escritos em Camel Case.
Ex:

class Mage {
public:
   int manaPoints() { return this->_manaPoints; }
   void setManaPoints(int manaPoints) { this->_manaPoints = manaPoints; }

private:
   int _manaPoints;

};