Принятые обозначения

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

Тип	Описание	Пример
Наименование корневых скриптов	Нижний регистр с разделителем слов - знаком подчеркивания.	index.php, goods_compare.php
Наименование модульных скриптов	Первое слово в названии скрипта - это имя компании или ее аббревиатура, второе слово - это название группы в которую группируются модули, и, наконец, третье и последующие слова - это слова на Ваше усмотрение, поясняющие, что делает скрипт. В качестве разделителей между словами используется знак подчеркивания.	melbis_inc.php, melbis_web_test.php, melbis_cataloge_sub.php
Названия функций в модульных скриптах	В каждом обычном модульном скрипте (за исключением модулей-библиотек) обязательно должна быть главная функция, которая вызывается автоматически. Главная функция модуля называется так же, как и сам скрипт, но полностью в верхнем регистре. Остальные функции в скрипте указываются в нижнем регистре с разделением слов знаком подчеркивания. При этом в начале их названия в качестве префикса должно стоять имя главной функции. Таким образом, обеспечивается уникальность имен функций, а также улучшается читаемость кода. Если Вы используете функцию из библиотеки, то по ее названию можно определить, в каком скрипте она находится.	Имя модуля: melbis_web_test.php Главная функция скрипта: function MELBIS_WEB_TEST($mVars) { ... } Вспомогательная функция: function MELBIS_WEB_TEST_func($mId, $mName) { ... }
Название ключей в HTML-шаблонах	Верхний регистр; в качестве разделителя слов - знак подчеркивания.	{MAIN}, {PAGE_NAME}, {HTML_CODE}
Глобальные переменные в скриптах	Начинаются с буквы "g" в нижнем регистре, далее каждое слово с заглавной буквы. Аббревиатуры пишутся как обычные слова. Для парсера рекомендуется использовать имя $gParser, для работы функции автозавершения кода.	$gParser, $gTitleHtmlPage
Локальные переменные внутри скриптов	Нижний регистр; в качестве разделителя слов - знак подчеркивания. Для SQL-запросов рекомендуется использовать переменную $command, для автоматической подсветки синтаксиса SQL.	function any_value() { ... $i = 1; $item_count = 5; ... }
Входные переменные для функций	Начинаются с буквы "m" в нижнем регистре, далее каждое слово с заглавной буквы. Аббревиатуры пишутся как обычные слова. В главной функции модульных скриптов, рекомендуется использовать переменную $mVars для массива входных параметров.	function MELBIS_WEB_TEST_func($mId, $mName) { ... } function MELBIS_WEB_TEST($mVars) { ... }
Константы в PHP-скриптах	Все буквы в верхнем регистре; в качестве разделителя слов - знак подчеркивания.	define('FOLDER', './'); define('DB_NICK', 'MS');