CodeStyle Cpp - miranadark/LearningEnglishWords GitHub Wiki

Короткое описание рекомендации:

// Пример кода (если возможно)

Имена, представляющие типы, должны быть обязательно написаны в смешанном регистре, начиная с верхнего:

Line, SavingsAccount

Имена переменных должны быть записаны в смешанном регистре, начиная с нижнего:

line, savingsAccount

Именованные константы (включая значения перечислений) должны быть записаны в верхнем регистре с нижним подчёркиванием в качестве разделителя:

MAX_ITERATIONS, COLOR_RED, PI

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

getName(), computeTotalWidth()

Все имена следует записывать по-английски:

fileName; // НЕ РЕКОМЕНДУЕТСЯ: imyaFayla

Имена объектов не указываются явно, следует избегать указания названий объектов в именах методов:

line.getLength(); // НЕ РЕКОМЕНДУЕТСЯ: line.getLineLength();

Слова get/set должны быть использованы везде, где осуществляется прямой доступ к атрибуту:

employee.getName(); employee.setName(name); matrix.getElement(2, 4); matrix.setElement(2, 4, value);

Слово find может быть использовано в методах, осуществляющих какой-либо поиск:

vertex.findNearestVertex(); matrix.findMinElement();

Множественное число следует использовать для представления наборов (коллекций) объектов:

vector points; int values[];

Префикс is следует использовать только для булевых (логических) переменных и методов:

isSet, isVisible, isFinished, isFound, isOpen

Симметричные имена должны использоваться для соответствующих операций:

get/set, add/remove, create/destroy, start/stop, insert/delete, increment/decrement, old/new, begin/end, first/last, up/down, min/max, next/previous, old/new, open/close, show/hide, suspend/resume, и т. д.

Следует избегать дополнительного именования указателей:

Line* line; // НЕ РЕКОМЕНДУЕТСЯ: Line* pLine; // НЕ РЕКОМЕНДУЕТСЯ: Line* linePtr;

Директивы включения следует сортировать (по месту в иерархии системы, ниже уровень — выше позиция) и группировать. Оставляйте пустую строку между группами:

#include #include

#include <qt/qbutton.h> #include <qt/qtextfield.h>

#include "com/company/ui/PropertiesDialog.h" #include "com/company/ui/MainWindow.h"

Следует инициализировать переменные в месте их объявления:

int x, y, z; getCenter(&x, &y, &z);