Версия для печати темы (https://pro1c.org.ua/index.php?s=47ba224178ab6c1209afd14733643877&showtopic=12812)

Автор: Vofka 07.06.13, 14:32

В связи с http://pro1c.org.ua/index.php?s=&showtopic=12659&view=findpost&p=70194 я решил посмотреть какая есть ещё информация по этой теме. Нашел интересный материал, делюсь с вами .

Одним из самых «комфортных» для программиста нововведений свежеиспеченной платформы стала реализация возможности контекстной подсказки по параметрам процедуры или функции. Мы все этого очень долго ждали, и хочется от души поблагодарить разработчиков за эту приятную неожиданность

Давайте скорей разбираться в том, как это работает.

В момент редактирования процедуры или функции в редакторе текстов модулей отображается всплывающая подсказка, как на рисунке:



Итак, контексная подсказка сообщает нам:

1. Мы работаем с Функцией;

2. Сейчас необходимо ввести параметр ТекстВопроса — это обязательный параметр;

3. ТекстВопроса может принимать значения с типом ФорматированнаяСтрока, Строка;

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

Некоторые особенности:

- Если параметр обязателен к заполнению, в контекстной подсказке к его наименованию добавляется постфикс (Обязательный), в противном случае подсказка отображает только наименование текущего параметра;

- Очень хочется, но пока возможности отображения типа возвращаемого элемента функции нет;

- Если процедура/функция/конструктор имеет несколько вариантов определения, отображается переключатель:



- В контекстной подсказке отображатся ссылки на описание типа текущего параметра в синтаксис-помощнике;

- Если используется подсказка по конструктору, то отображается почему-то «Функция»;

- Если используется подсказка по процедуре, то само слово «Процедура» почему-то не выделяется красным цветом, как «Функция»;

- По умолчанию, контекстная подсказка отображается автоматически при наборе «(» и «, «. Есть возможность управлять этой опцией в параметрах конфигуратора:



- Принудительно вызвать контектсную подсказку можно нажатием клавиш (Ctrl + Shift + Space) — упоминания об этом во встроенной справке не нашел ;

- Контекстная подсказка работает для как для встроенных процедур/функций/методов объектов/конструкторов, так и для пользовательских, но при этом, для того, чтобы получить информацию о типах параметров и их описание, требуется соответствие формату комментирования, описанных в документе Система стандартов и методик разработки конфигураций - о формате оформления во встроенной справке также ничего не нашел Методом «тыка»:

1. Если вообще ничего не описывать, то получим следующую картину:



Как видим, не очень-то информативно, но хоть что-то.

2. Если опишем комментарий перед функцией:



То есть, формат оформления должен быть следующим:

// %

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

// {НаименованиеПараметра} - % (тип параметра) - % (описание параметра)

// {НаименованиеПараметра} - % (описание параметра)

где:

% - любой набор символов

«жирным» выделены обязательные «литералы»

ЗЫ. Оригинал статьи находится http://pro1c.org.ua/redirect.php?http://aplastinin.ru/8-3-%D0%BA%D0%BE%D0%BD%D1%82%D0%B5%D0%BA%D1%81%D1%82%D0%BD%D0%B0%D1%8F-%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BA%D0%B0/

Автор: mister-x 07.06.13, 20:05

лінк вже битий

Автор: Vofka 08.06.13, 13:25

Вже робочий