Styl kodowania, propozycja
- nazwy plików oraz katalogów składają się wyłącznie z małych liter, możliwe jest stosowanie znaku '_' w nazwach
- kodowanie ASCII (Plain) - brak znaków narodowych w kodzie lub (dla dokumentacji i plików translacji) UTF-8
- rozszerzenia: .cpp, .hpp, .py, .as, .mxml
- komentarze i nazwy w języku angielskim
- podkatalog w C++ jest przestrzenią nazw, podkatalog w Pythonie jest pakietem, podkatalog w ActionScript jest pakietem
- każdy plik źródłowy oraz nagłówkowy powinien rozpoczynać się blokiem komentarza zawierającym opis
- każda klasa powinna być poprzedzona blokiem komentarza, który opisuje jej odpowiedzialność
- komentarze formatować zgodnie z zasadami definiowanymi przez program Doxygen
- nazwa przestrzeni nazw lub pakietu składa się wyłącznie z małych liter
- nazwy typów: klas, struktur, wyliczeń, definicji typów (typedef), parametry szablonów zaczynają się wielką literą, pozostałe są małe.
Jeżeli w takiej nazwie wykorzystuje się wiele słów, każde słowo na wielką pierwszą literę, np. 'MyClass'
- nazwy funkcji, metod rozpoczynają się małą literą, wewnątrz tych nazw można używać wielkich liter aby zwiększyć czytelność, np. dla nazw składających się z wielu słów, np. 'callAgain'
- składowe nazywane są tak jak nazwy funkcji - co opisano w poprzednim punkcie, na końcu umieszczamy podkreślnik '_'
- argumenty funkcji oraz zmienne lokalne składają się wyłącznie z małych liter, nazwy z wielu słów są rozdzielone podkreślnikami, np. 'from_time'
- elementy wyliczeń, nazwy stałych są pisane wyłącznie wielkimi literami, dozwolone jest rozdzielanie wyrazów podkreśleniami '_', np. 'RED_COLOR'
- zmienne globalne są nazywane tak jak typy, ale preferowane jest tutaj użycie singletonów
Przykład (wcięcia - 4 spacje na jeden poziom, styl 1TBS)
class MyClass {
public:
MyClass();
void methodOne(int first_param);
enum Color { BLACK, DARK_GREEN, BLUE, WHITE };
private:
Color color_;
};