Тип: Строка. Произвольная строка символов. Как правило, расшифровывает и поясняет имя объекта метаданных.
Полное описание, параметры и ограничения
ОбъектМетаданных: ОбщийМодуль.Комментарий (MetadataObject: CommonModule.Comment)
ОбъектМетаданных: ОбщийМодуль (MetadataObject: CommonModule)
Комментарий (Comment)
Доступен, начиная с версии 8.1.
Использование:
Только чтение.
Описание:
Тип: Строка.
Произвольная строка символов. Как правило, расшифровывает и поясняет имя объекта метаданных.
Доступность:
Сервер, толстый клиент, внешнее соединение, мобильное приложение (сервер), мобильный автономный сервер.
Использование в версии:
Доступен, начиная с версии 8.1.
Методическая информация
Практические примеры
Выбрать квалифицированное имя функции при переносе примера
Глобальный модуль и неглобальный модуль дают разные способы обращения к экспортным функциям. Мы проверяем настройку, но не придумываем несуществующую функцию.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Запускайте в учебной копии конфигурации. Примеры читают структуру метаданных, но не создают объекты, не записывают регистры и не проводят документы.
Сверяйте вывод с деревом конфигурации в Конфигураторе. Имена, длины и настройки в УНФ, КА2, БП, УТ 11 и УТ 10.3 могут различаться.
Имена объектов взяты из XML КА2 Progress: C:\claude\KA2\Progress\XML_CF_KA2_PROGRESS. Исходные XML не изменяйте. Выполняйте код только в своей учебной копии соответствующей конфигурации.
В другой конфигурации предварительно найдите аналогичный объект в Конфигураторе и замените только строку имени в поиске. Отсутствие имени обрабатывается до чтения свойств; оно не доказывает отсутствие аналогичной возможности.
Каждый урок запускайте отдельно. Код не вызывает бизнес-функции модулей и обработчики команд, не переключает привилегированный режим и не меняет параметры сеанса.
Описание = Метаданные.ОбщиеМодули.Найти("АвтономнаяРаботаСлужебный");
Если Описание = Неопределено Тогда
ВызватьИсключение "В учебной конфигурации отсутствует ОбщиеМодули.АвтономнаяРаботаСлужебный";
КонецЕсли;
Сообщить(СтрШаблон("Имя %1; глобальный %2", Описание.Имя, Описание.Глобальный));
Если Описание.Глобальный Тогда
Сообщить("Экспорт входит в глобальный контекст; проверьте уникальность имён и место выполнения");
Иначе
Сообщить("У неглобального общего модуля перед именем экспортной функции указывают имя модуля");
КонецЕсли;
Сообщить("Синоним для человека: " + Описание.Синоним);
Сообщить("Текст для человека: " + Описание.Представление());
Сообщить("Комментарий разработчика: " + Описание.Комментарий);Разбор по шагам
Поиск использует Имя объекта, а не пользовательское Представление.
Глобальный определяет включение экспорта в глобальный контекст, не доступность на всех клиентах.
Представление и Комментарий помогают найти назначение, но не являются кодом.
Перед переносом вызова найдите существующую экспортную функцию в модуле.
Как проверить результат
Для данного XML Глобальный = Ложь; вывод объясняет необходимость имени модуля.
Сверьте Имя, синоним и комментарий в Конфигураторе; не заменяйте имя модуля текстом его синонима.
Ожидаемый результат
Новичок различает имя API, описание и область видимости экспорта.
На что обратить внимание
Установить Глобальный ради сокращения записи — изменение архитектуры, не косметика.
В примере нет выдуманного вызова функции из типовой конфигурации.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Проверить, где доступен общий модуль УчебныеЗадачи
Разбираем флаги созданного учебного общего модуля и объясняем различие между Сервер и Вызов сервера.
Где и как запускать
Учебная база: создайте серверный общий модуль УчебныеЗадачи (флаг Сервер). Код без директив вставьте в тело процедуры ВыполнитьПример() Экспорт. Вызовите её из серверного обработчика команды учебной обработки. Не запускайте в рабочей базе.
Подготовка
Запускайте в учебной копии конфигурации. Примеры читают структуру метаданных, но не создают объекты, не записывают регистры и не проводят документы.
Сверяйте вывод с деревом конфигурации в Конфигураторе. Имена, длины и настройки в УНФ, КА2, БП, УТ 11 и УТ 10.3 могут различаться.
Используйте созданный для уроков общий модуль УчебныеЗадачи с флагом Сервер. Не включайте Привилегированный ради запуска примера.
Для второй проверки меняйте флаг Вызов сервера только у своего учебного модуля в копии базы, а не у типовых модулей.
Модуль = Метаданные.ОбщиеМодули.Найти("УчебныеЗадачи");
Если Модуль = Неопределено Тогда
ВызватьИсключение "Сначала создайте общий модуль УчебныеЗадачи в учебной базе";
КонецЕсли;
Сообщить(Модуль.ПолноеИмя());
Сообщить(Модуль.Представление());
Сообщить(СтрШаблон("%1 (%2)", Модуль.Имя, Модуль.Синоним));
Сообщить(Модуль.Комментарий);
Сообщить(СтрШаблон("Сервер: %1; вызов сервера: %2", Модуль.Сервер, Модуль.ВызовСервера));
Сообщить(СтрШаблон("Управляемый клиент: %1; обычный клиент: %2; внешнее соединение: %3",
Модуль.КлиентУправляемоеПриложение, Модуль.КлиентОбычноеПриложение, Модуль.ВнешнееСоединение));
Сообщить(СтрШаблон("Глобальный: %1; привилегированный: %2", Модуль.Глобальный, Модуль.Привилегированный));
Сообщить(Модуль.ПовторноеИспользованиеВозвращаемыхЗначений);
Если Модуль.Сервер И Не Модуль.ВызовСервера Тогда
Сообщить("Вызывайте процедуру из серверного обработчика. Прямой клиентский вызов серверного модуля этим флагом не разрешён");
КонецЕсли;
Сообщить(Модуль.ЕстьИзмененияРасширениямиКонфигурации());Разбор по шагам
Находим реальный общий модуль по имени и читаем его контексты выполнения.
Сервер отвечает за наличие серверного контекста; ВызовСервера — за возможность соответствующих обращений с клиента.
Отдельно смотрим доступность на клиентах и во внешнем соединении; не считаем их автоматически включёнными.
Привилегированность и повторное использование возвращаемых значений — отдельные настройки, не универсальное исправление ошибок вызова.
Как проверить результат
Вывод флагов совпадает с окном свойств учебного общего модуля.
При Сервер=Истина и ВызовСервера=Ложь выводится пояснение о серверном обработчике.
Изменение флага в Конфигураторе требует обновления конфигурации учебной базы перед повторной проверкой.
Ожидаемый результат
Новичок видит фактические контексты своего модуля и понимает, откуда его вызывать.
На что обратить внимание
Флаг Вызов сервера не отменяет необходимость Экспорт у вызываемого метода.
Метаданные не заменяют просмотр исходного кода модуля: здесь не извлекается его текст.
Не включайте привилегированный режим без анализа прав; пример не требует его.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.