Coding standarts and concepts.

Todo:
translate this page into english.

Правила именования и написания конструкций языка С++.

Имена классов начинаются с заглавной буквы. Если имя состоит из нескольких слов, то каждое из них начинают с заглавной буквы, пример
 class MyNameOfClass{}; 

Имена методов класса, а также объявления других типов и глобальных констант именуются аналогичным образом.

Имена переменных-членов класса начинаются с префикса m, например

 MyNameOfMyClass::mMyVariable 
.

define-ы пишутся заглавными буквами,в качестве разделителей слов можно использовать нижнее подчеркивание, например,

 #define MY_DEFINE true 
.

Имена локальных переменных остается на усмотрение програмиста, но не забывать про ясность и читабельность кода.

Перечисление аргументов производить через пробел и, вообще использовать пробелы и символы табуляции для придания коду читабельного вида.

Концепция выделения ресурсов.

Я придерживаюсь правила: кто ресурс выделил, то его и освобождает, если в одном обекте выделена память оператором new, то этот же объект должен ее удалить. Если кто-то получил ресурс через метод add/set, то есть присвоение указателя/ссылки, то он же должен отдать ресурс соответствующим методом Remove. Не знаю, насколько данный подход правилен...

File naming rules.

Обычно имя файлу дается аналогичное имени класса, только все символы в имени в нижнем регистре и для разделения слов используется нижнее подчеркивание. Заголовочные файлы окружаются директивами препроцессора. После последнего #endif оставляется пустая строка (чтобы G++ не ругался warning-ами)

Пример, имя файла my_class_name.h, в этом случае директивы выглядят следующим образом:

 #ifndef __my_class_name__header__
 #define __my_class_name__header__
 
 //...
 
 #endif

Generated on Thu Mar 5 22:36:42 2009 for gpucalc by  doxygen 1.5.6