Именование

Переменные

  1. Имена переменных в нижнем регистре, слова разделяются через нижнее подчеркивание
  2. Логические (boolean) переменные начинаются с префикса is_
  3. Имена массивов пишутся в множественном числе или оканчиваются на _list
  4. Имя переменной должно максимально точно описывать ее содержание

Примеры:

$var, $users_count, $is_active, $articles, $items_list

Функции

  1. Имена функций в lowerCamelCase - первая буква маленькая, каждое следующее слово с большой буквы
  2. В имени функции сначала указывается действие (add, get, remove), затем объект (Item, Article, User)

Примеры:

function addArticle(){}
function getListItems(){}
function removeOldLog(){}

Классы

Классы и методы классов именуются по тем же правилам, что и функции (lowerCamelCase)

Свойства классов именуются как обычные переменные

Файлы

  1. Имена файлов и каталогов всегда в нижнем регистре
  2. Слова разделяются нижним подчеркиванием

Структура кода

Теги <?php

Короткие теги <? .. ?> запрещены

Минимальная вложенность

Везде где можно избавиться от вложенности фигурных скобок - нужно от нее избавляться

В первую очередь касается конструкций if .. else

Если нужно выполнить блок кода если условие выполняется, то нужно делать так:

Хорошо:

 
if (!$is_good) { return false; }
 
doSomething();

Хорошо потому, что сразу видно что будет если условие не выполняется

Плохо:

 
if ($is_good) {
    doSomething();
} else {
    return false;
}

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

 
разработка/соглашения.txt · Последние изменения: 2010/11/10 16:08 От admin