Відгуки  >

Компанії давно був потрібний сайт, що відображає спеціфіку нашої діяльності. Деякий час ми перебували в повній впевненості, що в команди спеціалістів, здатної реалізувати такий специфічний проект швидко та за реальны кошти просто не існує...

KievRealty,
KievRealty

Публікації  >

Технології  >  Стандарти кодування компанії

Програмна частина будь-якого інтернет-проекту реалізується мовою програмування 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);
}

← До переліку технологій

Останній проект: Еврейская майса о том, как бывает в жизни важно втретить Рэбе в нужное время

На початок сторінки© 2017 ControlStyle, просування та розкручення сайтів, Київ.
Створення та розробка сайтів, Київ.