- В этой теме 1 ответ, 2 участника, последнее обновление 3 часа, 57 минут назад сделано
.
Просмотр 1 ветки ответов
Просмотр 1 ветки ответов
- Для ответа в этой теме необходимо авторизоваться.
Программирование и администрирование в 1С
База знаний Одина — Одинэсника › Форумы › ODIN — Форум по 1С Предприятию › Как добавить описание функции и процедуры в 1С?
Odin — Одинэсник.необходимо добавить корректное описание функции и процедуры
Чтобы добавить корректное описание функции и процедуры в 1С, нужно использовать комментарии в определённом формате, чтобы IDE показывала контекстную подсказку с описанием назначения и параметров.
Пример правильного описания процедуры:
|
1 2 3 4 5 6 7 8 9 |
// Процедура выполняет <описание назначения процедуры> // // Параметры: // ИмяПараметра1 – Тип – описание параметра 1 // ИмяПараметра2 – Тип – описание параметра 2 // Процедура ИмяПроцедуры(ИмяПараметра1, ИмяПараметра2) // тело процедуры КонецПроцедуры |
Пример правильного описания функции:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
// Функция возвращает <описание назначения функции> // // Параметры: // ИмяПараметра1 – Тип – описание параметра 1 // ИмяПараметра2 – Тип – описание параметра 2 // // Возвращаемое значение: // Тип – описание возвращаемого значения // Функция ИмяФункции(ИмяПараметра1, ИмяПараметра2) // тело функции Возврат Значение; КонецФункции |
Если функция или процедура без параметров, описание параметров можно опустить.
Пример с реальным описанием:
|
1 2 3 4 5 6 7 8 |
// Процедура рассчитывает сумму по строке табличной части // // Параметры: // СтрокаТЧ – ДанныеФормыЭлементКоллекции – данные текущей строки табличной части // Процедура РассчитатьСуммуТЧ(СтрокаТЧ) СтрокаТЧ.Сумма = СтрокаТЧ.Количество * СтрокаТЧ.Цена; КонецПроцедуры |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
// Функция возвращает розничную цену товара // // Параметры: // Номенклатура – СправочникСсылка.Номенклатура – ссылка на номенклатуру // // Возвращаемое значение: // Число – розничная цена товара // Функция РозничнаяЦена(Номенклатура) // логика расчёта цены Возврат Цена; КонецФункции |
Рекомендую использовать встроенный рефакторинг в конфигураторе: поставить курсор на имя функции/процедуры и выбрать «Рефакторинг» → «Создать описание функции/процедуры». Это автоматически вставит шаблон с комментариями, которые останется только заполнить.
Рекомендую посмотреть здесь:
https://its.1c.ru/db/v831doc#bookmark:dev:refactoring:description-function-procedure
База знаний 1С