Комментарии

Для упрощения работы стороннего лица с HTML-документом иногда возникает необходимость разделения его смысловых блоков используя узлы комментариев. При помощи комментариев имеет смысл разделять такие блоки, как например заголовок, навигация, нижний колонтитул и пр. Как правило, эти фрагменты кода отмечают парой комментариев – начало блока и конец. Весьма разумным является отметка при помощи комментариев повторяющихся фрагментов кода, которые, возможно, в будущем будут генерироваться автоматически. Однако, не стоит злоупотреблять использованием комментариев, так как это приведет к усложнению читаемости кода и его редактирования. Рассмотрим пример использования узла комментария для разделения смысловых блоков документа:

Образец комментированного блока

<!-- navigation start -->

<ul id=”navigation”>

…

</ul>

<!-- navigation end -->

Как видно из примера, комментарии должны содержать информацию о том, что это за блок (navigation), где он начинается (start) и где заканчивается (end).

При работе с иностранными клиентами, комментарии ни в коем случае не должны содержать русскоязычные названия и аббревиатуры, желательно вообще избегать русскоязычных комментариев. Текст комментариев должен быть только на английском языке!