Документирование в формате XML

XML (extensible Markup Language) — это язык разметки текста. Разметкой яв­ляется все, что не относится к содержанию, или, как модно говорить, контенту: структура документа, формат, вид и т. д. Разметка осуществляется с помощью тегов — управляющих элементов, заключенных в угловые скобки. Теги в XML всегда парные: открывающий тег записывается перед размечаемым фрагментом, а закрывающий — после него. Закрывающий тег выглядит так же, как открываю­щий, но предваряется косой чертой, например:

<summary> Класс для работы с регулярными выражениями </summary>

В тегах могут присутствовать атрибуты — элементы вида имя = значение, уточ­няющие и дополняющие описание элемента.

Язык XML широко распространен в Интернете благодаря его универсальности и переносимости. Корпоративные приложения используют XML как основной формат для обмена данными. Строго говоря, XML является не языком, а систе­мой правил для описания языков.

ПРИМЕЧАНИЕ

Многие составляющие технологии.NET неразрывно связаны с XML, поэтому в про­странстве имен System.Xml библиотеки.NET описано множество классов, под­держивающих XML. Объем и задача учебника не позволяют описать эти классы и технологии.

Любой программный продукт требуется документировать. Соответствие версий документации и программы — серьезная проблема, которая решается в.NET встраиванием документации прямо в код программы с помощью комментари­ев и XML-тегов.

Комментарии, используемые для построения файлов документации, начина­ются с символов /// и размещаются перед соответствующим элементом про­граммы. Внутри комментариев записываются теги, относящиеся к комменти­руемому элементу — классу, методу, параметру метода и т. п. Теги перечислены в табл. 15.5.

Таблица 15.5. Теги документирования