Правила именования чанков, сниппетов, шаблонов, TV
Здравствуйте, Василий.
Хотел бы спросить лично у Вас, как Вы именуете:
а) чанки
б) сниппеты
в) шаблоны
г) TV-параметры
д) категорий ресурсов
е) группы TV-параметров
Всё-таки, опыта у много и наверняка у Вас сложились какие-то определённые правила именования, которых Вы придерживаетесь.
В частности, меня интересуют следующие моменты:
1. Нужно определиться с 2 видами разделителей: мягкий разделитель и жёсткий разделитель. Например: xxxXxx_yyyYyy — здесь разделителем самого высокого уровня является символ подчёркивания, мягким разделителем — заглавная буква.
Возможные варианты:
а) xxxXxx_yyyYyy
б) xxx-xxx_yyy-yyy
в) xxx_xxx.yyy_yyy
а) xxxXxxYyyYyy (используется только один разделитель — заглавная буква)
б) xxx_xxx_yyy_yyy (используется только один разделитель — знак подчёркивания)
в) xxx.xxx.yyy.yyy (используется только один разделитель — точка)
2. Нужно определиться, использовать ли префикс типа объектов — префикс чанка, префикс шаблона, префикс сниппета, префикс TV-параметра, префикс категории или группы.
Если использовать, то где — в начале или в конце.
3. Нужно учитывать, что шаблон может быть внешним. При этом имя внешнего файла желательно, чтобы совпадало с именем внешнего шаблона. Но требования к именам файлов уже иные, нежели к объектам, хранящимся в БД modX.
4. Нужно решить, будут ли в именах TV-параметров дублироваться имя группы, к которой они принадлежат?
Спасибо.
Хотел бы спросить лично у Вас, как Вы именуете:
а) чанки
б) сниппеты
в) шаблоны
г) TV-параметры
д) категорий ресурсов
е) группы TV-параметров
Всё-таки, опыта у много и наверняка у Вас сложились какие-то определённые правила именования, которых Вы придерживаетесь.
В частности, меня интересуют следующие моменты:
1. Нужно определиться с 2 видами разделителей: мягкий разделитель и жёсткий разделитель. Например: xxxXxx_yyyYyy — здесь разделителем самого высокого уровня является символ подчёркивания, мягким разделителем — заглавная буква.
Возможные варианты:
а) xxxXxx_yyyYyy
б) xxx-xxx_yyy-yyy
в) xxx_xxx.yyy_yyy
а) xxxXxxYyyYyy (используется только один разделитель — заглавная буква)
б) xxx_xxx_yyy_yyy (используется только один разделитель — знак подчёркивания)
в) xxx.xxx.yyy.yyy (используется только один разделитель — точка)
2. Нужно определиться, использовать ли префикс типа объектов — префикс чанка, префикс шаблона, префикс сниппета, префикс TV-параметра, префикс категории или группы.
Если использовать, то где — в начале или в конце.
3. Нужно учитывать, что шаблон может быть внешним. При этом имя внешнего файла желательно, чтобы совпадало с именем внешнего шаблона. Но требования к именам файлов уже иные, нежели к объектам, хранящимся в БД modX.
4. Нужно решить, будут ли в именах TV-параметров дублироваться имя группы, к которой они принадлежат?
Спасибо.
Комментарии: 3
От себя скажу, что на сайтах обычно разделяю имена с помощью точки, именую элементы по назначению. Т.е. если есть какой-то блок навигации, то будет что-то вроде nav.item и nav.item.row.
row — всегда строка какого-либо списка
Что касается составных имен блока, то пользуюсь camelCase-форматом.
В php я придерживаюсь стандарта PSR-1,2, где есть возможность PSR-0 (в modx пока нереально).
В остальном помогает здравый смысл и забота о тех, кто будет код поддерживать.
row — всегда строка какого-либо списка
Что касается составных имен блока, то пользуюсь camelCase-форматом.
В php я придерживаюсь стандарта PSR-1,2, где есть возможность PSR-0 (в modx пока нереально).
В остальном помогает здравый смысл и забота о тех, кто будет код поддерживать.
Василий, Иван, а шаблоны как именуете? Внутренние и внешние.
Авторизуйтесь или зарегистрируйтесь, чтобы оставлять комментарии.