235  /  331

Соглашение об именовании

Просмотров: 1774 (Статистика ведётся с 06.02.2017)
  • Общие понятия
  • Именование переменных
  • Именование методов и функций
  • Префиксы переменных
  • Именование классов
  • Доступность членов-переменных и методов класса
  • Именование констант
    1. Общие понятия.

      Не используйте подчеркивание для отделения слов внутри идентификаторов, это удлиняет идентификаторы и затрудняет чтение.

      Старайтесь давать переменным, методам и пр. "говорящие" названия. Предпочтительно использовать имена, которые ясно и четко описывают предназначение и/или смысл сущности.

      Старайтесь делать имена идентификаторов как можно короче (но не в ущерб читабельности).

      Если в имени содержится аббревиатура, лучше вместо всех заглавных оставить только первую букву заглавной, а остальные написать строчными. Т.е. лучше задать имя getHtmlStatistic, а не getHTMLStatistic.


    2. Именование переменных

      Первое логическое слово должно начинаться с маленькой буквы, остальные логические слова - с большой. Имена переменных могут иметь префиксы, если требуется явно указать тип переменной: ar - для массивов, db - для наборов данных из базы и т.п.

      Пример: $testCounter, $userPassword.


    3. Именование методов и функций

      Каждое логическое слово должно начинаться с заглавной буквы (стиль Паскаль). Например: CountVariable, ChangeUserPassword.


    4. Именование методов (для ядра D7)
      • Очевидность из названия действия, которое будет совершать функция\метод.
      • Использование префиксов: is (обозначение вопроса), get (получить значение), set (установить значение).

      Пример: isFileWriteable()


    5. Префиксы переменных

      PHP - не особо типизированый язык и в нем различаются по смыслу только три группы типов: скалярные, массивы и объекты.

      Массивы следует именовать с префиксом ar, при этом следующее логическое слово в названии начинается с большой буквы. Например, $arResult, $arModifiedUsers.

      Объекты следует именовать с префиксом ob, при этом следующее логическое слово в названии начинается с большой буквы. Например, $obElement, $obUser.

      Объект класса CDBResult следует начинать с префикса db, при этом следующее логическое слово в названии начинается с большой буквы. Например, $dbResult.

      Скалярные типы следует начинать с префиксов только в том случае, если точно известно, что они имеют заданный тип. Например в коде:

      $userID = $_REQUEST["var"];
      $userID = IntVal($userID);
      

      переменная идет без префикса, так как ее тип меняется по ходу выполнения программы.

      В коде: $bFlag = (($aaa > 0)? True : False); переменная идет с префиксом, так как ее тип в общем известен и не меняется.


    6. Именование классов

      Имя класса должно начинаться с буквы C. Если класс принадлежит модулю, то дальше должно идти "фирменное" название модуля. Каждое логическое слово должно начинаться с заглавной буквы. Пример: CIBlockElement, CIBlockType, CSaleAffiliate.

      Если класс различается для разных СУБД и соответственно имеет базовый класс с общими для всех СУБД методами, то этот базовый класс должен в своем имени после символа C содержать символы All. Пример: CAllSaleAffiliate.


    7. Именование констант

      Константы должны писаться большими буквами и иметь префикс BX_. Например, BX_ROOT, BX_FILE_PERMISSIONS.


    7
    Курсы разработаны в компании «1С-Битрикс»

    Если вы нашли неточность в тексте, непонятное объяснение, пожалуйста, сообщите нам об этом в комментариях.
    Развернуть комментарии