Правильное комментирование участков кода в шаблонах

Разработка под LiveStreet CMS
Короткая заметка для всех верстальщиков и прочих девелоперов, которые:

  • делают
  • модифицируют/дорабатывают шаблоны по заказам

Когда вы комментируете код внутри шаблона, не используйте хтмл-комментарии:

<!-- не нужно использовать такие комментарии внутри шаблонов для кода, только для описания -->

используйте комментарии шаблонизатора Smarty:

{* это комментарий шаблонизатора смарти *}

В связи с тем что:

  1. Если в комментируемом вами участке кода будет хук, например, вы закомментировали блок вывода меню и если какой-то плагин будет через этот хук добавлять свой новый пункт, в котором также есть комментарий, то будет повреждена верстка. Пример:
    
    <!--<div id="nav-fixed">
    <ul class="nav-navigation" id="nav-main">
    		<li class="active"><a href="#">Топики</a></li>
    		<li><a href="#">Блоги</a></li>		
    		<li><a href="#">Люди</a></li>
    		<li><a href="#">Активность</a></li>
    
    		<!-- Новый пункт меню от плагина (здесь был хук) -->
    		<li><a href="#">Новый пункт меню</a></li>
    		<!-- /Новый пункт меню от плагина -->
    </ul>
    </div>-->
    


    В данном примере весь комментарий, охватывающий блок меню
    <div id="nav-fixed">
    будет оборван после первого комментария на месте хука т.е. внезапно вылезет код:
    
    		<li><a href="#">Новый пункт меню</a></li>
    		<!-- /Новый пункт меню от плагина (здесь был хук) -->
    </ul>
    </div>-->
    

    посреди страницы, где его быть не должно.

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

  3. Комментарии нужны для разработчика шаблона, пользователю в браузере они не нужны вообще

  4. Меньше объем страницы, больше скорость загрузки — больше нравитесь гуглу, который ранжирует быстрые сайты выше в поисковой выдаче

  5. и т.п.

Работая с инструментом правильно можно достичь хороших результатов. Учитесь работать со смарти.
0 комментариев
Только зарегистрированные и авторизованные пользователи могут оставлять комментарии.