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

Не стоит пренебрегать комментариями, помечайте важные правила, давайте пояснения – в дальнейшем не придется ломать голову и вспоминать – «для чего и зачем это я сделал этот так а не иначе».

Комментарии для разных типов файлов во фреймворке webasyst:

Комментарии в файлах HTML (комментарий обработчика smarty)

{* содержимое коментария html *}

* содержимое этого комментария не будет отражаться в исходном коде документа

* Внутри могут находиться любые символы, кроме сочетания символов "*}" (что обозначает закрытие комментария).

Комментарии в файлах HTML (комментарий html)

<!-- содержимое коментария html -->

* содержимое этого коментария не будет отображаться в браузере но будет размещено в исходном коде

* внутри комментариев может находиться что угодно, кроме двух дефисов подряд (--). (* Подобное сочетание символов воспринимается как часть комментария и в некоторых браузерах может вызвать ошибку).

* конструкции комментариев html не могут быть размещены внутри открывающего или закрывающего тега

Комментарии для конструкций CSS (файлы CSS и содержимое элементов "style")

/* содержимое коментария CSS */

* Содержимое комментария не будет обрабатываться браузером но будет размещено в исходном коде

* Внутри могут находиться любые символы, кроме сочетания символов "*/" (что обозначает закрытие комментария).

Комментарии для конструкций JS (файлы JS и содержимое элементов "script")

/* содержимое коментария CSS */

* Содержимое комментария не будет обрабатываться браузером но будет размещено в исходном коде

* Внутри могут находиться любые символы, кроме сочетания символов "*/" (что обозначает закрытие комментария).

Общее правила для всех комментариев

Содержимое комментария может размещаться как на одной, так и на нескольких строках.

Комментарии могут находиться в любом месте документа, кроме как не в самих комментариях.