Чеклист для Bitrix

Внимательно ознакомиться с предыдущими базовыми принципами и в первую очередь следовать им. Далее:

1. Все js файлы с функциями должны располагаться в папке /js/ (либо в редких случаях в одной папке с исполняемым файлом), функции должны быть сгруппированы логически в группы и разненесы в файлы. Также как и любой другой язык, js код должен быть документирован. Предпочтительно использовать библиотеку jquery.

2. Все используемые свойства или инфоблоки должны быть задефайнены в файле /bitrix/php_interface/init.php

3. Компоненты: файлы, расположенные в открытых для клиента директориях должны содержать либо текстовый редактируемый блок, либо вызов компонента(2.0 - MVC/1.0 - обычный исполняемый код). Компоненты 2.0 не допускается вызывать из подпространства шаблонов, т.е. папки /bitrix/templates/.default/components не должно существовать. Все компоненты располагаются в едином пространстве /bitrix/dquad/. В случае использованя комплексных компонентов шаблоны также необходимо вынести в эту директорию, т.е. недопустимо создавать пространство(dquad,bitrix) внутри компонента. Папки /bitrix/components/dquad/news/templates/.default/bitrix не должно существовать. CSS стили, используемые в шаблоне компонентов должны храниться в той же папке, рядом с файлом template.php и называться style.css.
Примечание: если вёрстка создавалась ранее, чем был спрограммирован компонент, то допускается оставлять стили в общих файлах.

*При модификации компонента необходимо удалить из специальных файлов ненужные параметры, которые не используются на данном сайте, а также описать собственные параметры, в случае их добавления. Если настройка шаблона выводимой информации не требуется, достаточно использовать комопоненты 1.0.

4. Классы и функции: все классы и функции должны быть расположены в папке /bitrix/php_interface/include/dquad_classes /bitrix/php_interface/include/dquad_functions файл /bitrix/php_interface/include/dquad_classes/index.php содержит все классы, которые подключаются из этой же директории допустимо разделять /bitrix/php_interface/include/dquad_classes/PublicClasses.php /bitrix/php_interface/include/dquad_classes/AdminClasses.php это необходимо на сайтах, которые используют модифицированную административную часть, где невозможно использовать весь набор классов в публичной части.

Допускается группировать классы по подпапкам, если их много и они имеют несколько иерархических деревьев. Функции также необходимо разгруппировывать по файлам, и подключать как классы в одном общем файле /bitrix/php_interface/include/dquad_classes/functions.php

5. Весь неиспользуемый мусор необходимо удалять, либо выносить в папку /tools/, в крайних случаях допускается вести 2 версии одного файла, чтобы не возвращаться к ревизиям, для этого предыдущий файл нужно начинать с символа "_"

[Для неопытных] 6.При создании или модификации вёрстки не допускается изменять главные css, лежащие в директории /css/, нужно создать дополнительный файл типа ext_[name_css].css, подключить его после основных файлов и перезаписать стили.

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

8. Не допускается оставлять системные теги в публичной части, где их может отредактировать или удалить клиент.

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