Комментарии являются конструкцией SGML, и обычно имеют смысл только внутри DTD. Однако, как Разд. 3.4 показывает пример, в вашем документе возможно использовать синтаксис SGML.
Разделителем для комментариев SGML является строка ''--''. Первое появление такой строки открывает комментарий, а второе его закрывает.
Пример 3-8. Комментарий SGML общего вида
<!-- Тестовый комментарий -->
<!-- Это находится внутри комментария --> <!-- Это еще один комментарий --> <!-- Это один из способов создания многострочных комментариев --> <!-- Это другой способ -- -- создания многострочных комментариев -->
Если ранее вы использовали HTML, вы можете заметить различия в правилах для комментариев. В частности, вы можете думать, что строчка <!-- открывает комментарий, и закрывается только -->.
Это не так. Во множестве веб-браузеров анализаторы HTML работают неправильно, и воспринимают такой синтаксис как правильный. Однако анализаторы SGML, используемые в Проекте Документирования, гораздо более строги, и не пропустят документы, в которых сделана эта ошибка.
Пример 3-9. Комментарии SGML с ошибкой
<!-- Это находится внутри комментария -- ЭТО ВНЕ КОММЕНТАРИЯ! -- снова внутри комментария -->
Анализатор SGML будет интерпретировать, как будто на самом деле это было так;
<!ЭТО ВНЕ КОММЕНТАРИЯ>
Это неправильный SGML, и может дать непонятные сообщения об ошибках.
<!--------------- Это очень плохая идея --------------->
Как и указано в примере, не пишите такие комментарии.
<!--===================================================-->
Такой подход (несколько) лучше, но все же может запутать новичков в SGML.
Добавьте несколько комментарии в example.sgml и проверьте файл при помощи nsgmls.
Добавьте несколько неправильных комментариев в example.sgml и посмотрите на сообщения об ошибках, которые выдает nsgmls, когда встречает неправильный комментарий.
Пред. | Начало | След. |
Возвращение к SGML | Уровень выше | Сущности |
Этот, и другие документы, могут быть скачаны с ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.
По вопросам, связанным с FreeBSD, прочитайте документацию прежде чем писать в <questions@FreeBSD.org>.
По вопросам, связанным с этой документацией, пишите <doc@FreeBSD.org>.
По вопросам, связанным с русским переводом документации, пишите в рассылку <frdp@FreeBSD.org.ua>.
Информация по подписке на эту рассылку находится на сайте проекта перевода.