Личное соглашение кодирования

Опубликовано: 2012-09-04 04:28:18

Именование

varName - переменная

SomeClass - класс

some_method - метод

aArray - массив

Отступы

во вложениях условий, циклах - 1 таб

for() {

    // some action

}

Комментарий - 1 пробел

Пропуски строк

Условия и циклы - одна пробельная строка сверху;

Метод - две пробельные строки сверху;

Класс - две пробельные строки сверху;

Группы схожих по смыслу переменных - одна строка сверху;

Комментарий - одна строка сверху

Исключения

// some comment

if (condition) {

    // some comment

    if (condition) {

        // some action

    }

}

for() {

    for() {

        // some action

    }

}

Коды return

Null - ошибка при выполнении

1 - Ok

Методы

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

Описание входных данных

Описание выходных данных

Класс

Краткое описание класса

Константы

SOME_CONST

Префиксы

g_varName - Глобальные переменные