5.3.27 short: Короткое описание

На верх  Назад  Вперёд

Краткое (short) описание используется для краткого описания идентификатора. Если возможно, описание должно соответствовать одной строке текста. Содержимое этого тега будет использоваться для следующих целей:

Используется как синопсис на странице, которая описывает идентификатор.

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

Заменяет метку descr в element, если нет тэга descr.

В описании перечисляемого типа значения перечисления набираются в таблице, каждая строка содержит имя значения и краткое описание.

В описании функции или процедуры, принимающей аргументы, за аргументами следует краткое описание.

В объявлении класса или записи каждому методу, полю или свойства следует краткое описание.

Пример:

<element name="MyEnum.meOne">
<short>Первый элемент MyEnum</short>
</element>

Смотри также: element (173), descr (165)