Docl: однострочная директива документирования кода Назад В начало Вперед

Однострочная директива #docl оформляется как первый элемент однострочного комментария:

<однострочный-оператор-документирования> = // #docl <документация>

<документация> - описание документируемого объекта, см. раздел "Doc: документирование кода. ".

В отличие от многострочного описания, однострочная директива должна располагаться после документируемой конструкции.

Однострочная директива #docl является частью комментария, поэтому макроподстановка в ней не выполняется. Если нужно использовать макросы, следует использовать директиву #doc общего вида (многострочную).

Пример

function IsEmpty(
// #docl Функция проверяет наличие ресурсов у заданного владельца.</brief>
				cMaster : comp
// #docl NRec владельца ресурсов.
				) : boolean;
// #docl true - список ресурсов пустой, false - не пустой.

Версия

Атлантис 5.2.08.