Рекомендации к редактору TEditor

Для удобства работы мы размещаем документацию к компонентам в коде самих компонентов. Весь код также содержит поясняющие комментарии и, более того, мы реализовали возможность навигации по тексту PHP, HTML, JS и CSS файлов при помощи специальных меток. Для осуществления навигации мы рекомендуем пользоваться редактором Exogens TEditor.

Маркировка блоков

В CMS RUEN для каждого блока (страницы) не создаётся отдельных файлов PHP, TPL и пр., а всё размещается в едином PHP-файле, являющимся компонентом. Поэтому возникает необходимость удобной навигации между блоками и в принципе встает вопрос визуальной идентификации блоков.

Отделение блоков

Каждый блок, то есть часть кода, отвечающий за определённую страницу, следует отделять специальными комментариями, которые будут легко различимы в самом коде, а при использовании TEditor они дадут возможности удобной навигации.

###label Компонент
#
#

... PHP-код для данной части страницы ...

#
#
##### Компонент

Наименование блоков

Способ наименования блоков, показанный на примере, изрядно помогает при навигации по коду компонентов. Кроме того, он помогает соблюдать логику компонентов.

###label Компонент
###label Компонент | Раздел
###label Компонент | Раздел | Подраздел

Комментарии и документация

Компоненты CMS RUEN являются обычными PHP-файлами, поэтому в них можно пользоваться традиционными способами комментирования. При этом мы рекомендуем пользоваться комментированием через # и в этом случае комментарии лучше располагать на отдельных строках (это необходимо для корректной работы внутренних механизмов оптимизации).

Документация

В каждом компоненте можно разместить соответствующую документацию, которая будет доступна в любой момент посредством дополнительного окна «Выдержка». При этом вы сможете править код компонента и видеть документацию. Более того, в том же окне автоматически отобразится список всех таких блоков документации.

###label##  Документация | Продукты  ###################################################################################
#
# Текст
#
########################################################################################################################

Комментарии к блоку

###label Компонент
#
#  Текст комментария
#

... PHP-код для данной части страницы ...