Примеры аннотации курильщика и аннотации здорового человека приведены в листингах 3.4 и 3.5. Они говорят сами за себя.

Листинг 3.4. Аннотация курильщика — бесполезный пересказ названия

// Выполняет удаление лишних документов.

//

// Параметры:

// Отказ - Булево, флаг указывает на неудачную попытку синхронизации.

// ТаблицаИзОбработки – Не определено, если запускается из

// регламентного задания. Содержит таблицу

// значений НайденныеДокументы со списком

// удаляемых документов, если запускается из

// формы обработки.

// ЭтоФоноваяЗадача - Булево, флаг указывает на запуск процедуры в

// качестве фоновой.

// Пользователь - СправочникСсылка.Пользователи, пользователь, который

// инициировал запуск синхронизации.

// РежимТранзакции - Булево, флаг указывает на необходимость

// использования режима управляемой транзакции.

//

Процедура УдалениеЛишнихДокументов(Отказ, ТаблицаИзОбработки,

ЭтоФоноваяЗадача = Ложь,

Пользователь = Неопределено,

РежимТранзакции = Неопределено,

Режим2012 = Ложь,

Протокол = Неопределено) Экспорт

Листинг 3.5. Аннотация здорового человека — краткая и осмысленная

// Извлекает из репозитория параметры указанных источников данных,

// формирует из них структуру (параметры, имена полей и параметров,

// необходимые временные таблицы и т.д.).

//

// Параметры:

// ВхДанные - СправочникСсылка.УниверсальныеИсточникиДанных,Массив -

// Источник (-и) данных, которые необходимо подготовить к

// выполнению.

//

// Возвращаемое значение:

// Структура - Полный контекст набора источников.

//

Функция КонтекстДинамическихДанных(ВхДанные) Экспорт

Читатель спросит: «Каким образом можно написать внятную и понятную аннотацию для крохотного и очевидного метода?» Отвечаем: очень просто, см. листинг 3.6.

Листинг 3.6. Аннотация без аннотации — так тоже можно

// Аннотация не требуется, см. имя метода.

//

// Параметры: