3.5 Коментари

Коментарите са SGML конструкция и обикновенно са валидни само в DTD. Все пак както Section 3.4 показва, възможно е да се използва SGML синтаксис вътре в документ.

Разделителя за SGML коментари е стринга ``--''. Първото появяване на този стринг отваря коментар а второто го затваря.

Example 3-8. SGML общ коментар

<!-- тест за коментар -->
<!-- Това е вътре в коментара -->

<!-- Това е друг коментар    -->

<!-- Това е начин
     за коментар от н&#255;колко линии -->

<!-- Това е друг начин за коментиране  --
  -- на н&#255;колко линии -->

Ако сте използвали HTML преди, може да сте виждали различни правила за коментари. По-специално може би смятате, че стринга <!-- отваря коментар и той може да се затвори само от -->.

Това не е вярно. Много от уеб браузерите имат невалидни HTML парсери и ще приемат това като валиден коментар. SGML парсерите използвани от Проекта за Документация са много по стриктни и ще откажат документ в които се съдържа тази грешка.

Example 3-9. Неправилни SGML коментари

<!-- Това е в коментар --

     ТОВА Е ИЗВЪН КОМЕНТАР!

  -- това е вътре в коментар -->

SGML парсера ще третира това като че е;

<!ТОВА Е ИЗВЪН КОМЕНТАРА>

Това не е валиден SGML и може да предизвика объркващи съобщения за грешки.

<!--------------- Това е много лоша иде&#255; --------------->

Както се казва в текста, не пишете такива коментари.

<!--===================================================-->

Това е малко по-добър начин, но вероятно ще обърка хората, нови в SGML.

3.5.1 За упражнение...

  1. Добавете коментари в example.sgml и проверете дали все още е валиден като използвате nsgmls(1)

  2. Добавете невалидни коментари в example.sgml и вижте съобщенията за грешки, които nsgmls(1) връща когато срещне невалиден коментар.

Този и други документи можете да намерите в ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

За въпроси отностно FreeBSD, прочетете документацията преди да попитате в <questions@FreeBSD.org>.
За въпроси отностно този документ, e-mail <doc@FreeBSD.org>.