[belugin]

У нас есть вот такая штука:

XppDoc -- это инструмент, который делает из комментариев к исходникам справку

== Формат комментариев ==

*Все комментарии начинаются с начала строки и предваряются тремя слешами
*Комментарии пишутся перед тем что они комментируют
*Комментарии можно разделить на секции. Каждая секция предваряется строкой с @<название секции>:
*@desc -- описание
*@params -- параметры метода
*@ret -- возвращаемое значение метода
*@example -- пример использования
*@see -- см. также
*формат каждой строки в секции: <имя><пробел><необязательное описание>, где
*<имя> -- имя метода класса или поля в таблице в том же классе/таблице или полный путь к элементу AOT
*<необязательное описание> -- любой текст


== Пример ==

/// Поиск адреса 
///@desc
///  Ищет адрес по заданным параметрам, в случае неуспеха возвращает пустой буфер
///@params
///  tableID -- идентификатор таблицы
///  recId -- идентификатор записи
///  addressType -- тип адреса
///  update -- если true, выбирается для обновления
///@ret
///  Найденная запись, если запись не найдена, то пустой буфер
///@example
///   Address::find(tableNum(Address), 1212312, AddressType::AddressType1, true)
///@see
///   exist -- проверка существования адреса по первичному ключу
///   \Classes\AddressCheck -- проверка адреса
static Address  find(tableId        tableId,
                     recId          recId,
                     AddressType    addressType,
                     boolean        update = false)
{