Стандарты кодирования компании / Статьи / ControlStyle
Статьи

Стандарты кодирования компании

Программная часть любого интернет-проекта реализуется на языке программирования PHP 4-й версии. При разработке любого проекта должны соблюдаться следующие идеологические правила:

  • Совместимость. Необходимо стараться избегать применения новых функций, появившихся в последних версиях PHP, до тех пор пока указанные версии языка не получат массовое распространение на большинстве хостинговых серверов.
  • Переносимость. Необходимо также обязательно проверять наличие расширений языка (не используемых по умолчанию в языке) перед вызовом той или иной функции, относящейся к соответствующему расширению, либо вообще отказаться от использования указанных функций.
  • Модульность. При разработке проекта на языке программирования PHP следует соблюдать модульность, т. е. разделять основную логику программы от вспомогательных функций и процедур, группировать последние по своему общему предназначению (к примеру, модуль работы с файлами, модуль работы с базой данных, модуль рендеринга форм и т. п).
  • Универсальность. Применяемые при разработке проекта модули, функции должны быть по возможности максимально универсальными (пригодными для повторного использования кода в будущих проектах). Таким образом, необходимо избегать повторного написания одного и того же кода.
  • Читаемость и понятность кода. При написании кода требуется соблюдать принятый в компании стандарт оформления исходного кода (см. ниже), а также комментировать сложные участки кода на английском или русском языках.
  • Структура каталогов проекта. При использовании сложной структуры каталогов проекта следует однозначно определять название каталога и его предназначение.
  • Отделение содержания от представления. В случае разработки интернет-проекта требуется строгое отделение содержания страницы от ее представления (оформления).

Стандарт оформления исходного кода

  1. Исходный код программы оформляется в любом текстовом редакторе, поддерживающем кодировку UTF-8. При наборе исходного кода не допускается эмуляция табуляции пробельными символами. Принятый в компании для табуляции отступ — 4 символа.
  2. При разработке программных модулей обязательным является указание даты и времени последнего редактирования модуля, а также авторских прав на него.
  3. Уровень вложенности логических блоков программы должен быть наглядно представлен в тексте программы с использованием символов табуляции. Блоки первого уровня не должны иметь отступа. Допускается логическое разделение участков кода за счет введения одной пустой строки между ними.
  4. Комментарии, разъясняющие работу сложных участков кода, должны быть оформлены при помощи комментирующего символа «#». Не допускается комментирование строк при помощи последовательности символов «//».
  5. Символы «{» и «}», используемые в классах, циклах и условных операторах, всегда должны применяться с новой строки.
  6. Имена переменных, классов, функций должны задаваться латинскими буквами в нижнем регистре. Допускается использование в имени символа «_».
  7. Имена констант должны задаваться только большими латинскими буквами. Допускается использование в имени символа «_».

Образец правильно оформленного кода:

define('THIS_SITE', 1);

# если тип элемента text, file, password или combobox
if (in_array($this->type, array('text', 'file', 'password', 'combobox')))
{
    # если встречается символ '#', то устанавливаем флаг перевода строки
    if (substr($lbl, strlen($lbl)-1, 1) == '#') $this->set_var('label_self_line', 1);
}
else
{
    # сбрасываем флаг перевода строки
    $this->set_var('label_self_line', 0);
}

Николай И. Яровой

Комментировать через

Вконтакте Facebook

К списку статей