Создание документации к пользовательскому инструменту геообработки позволит другим пользователям понять и эффективно использовать ваш инструмент. Документацию можно частично создать с помощью диалогового окна Свойства инструмента, а также метаданных инструмента.
Свойства инструмента
Задайте свойства, перечисленные ниже, чтобы составить документацию инструмента в диалоговом окне Свойства. Чтобы открыть диалоговое окно Свойства, щелкните правой кнопкой мыши инструмент на панели Каталог.
рядом с надписью параметра.Метаданные
Чтобы создать полную справочную документацию по инструменту, измените его метаданные или описание элемента, которые содержат следующие компоненты:
- Заголовок — Имя пользовательского инструмента.
- Образец — Значок, который отображается при наведении курсора мыши на инструмент на панели Каталог.
- Теги — Ключевые слова, используемые для поиска инструментов на панели Каталог или виде Каталог.
- Краткое описание (резюме) - Краткая информация о задаче, которую решает инструмент, а также примеры использования. Краткая информация отображается при наведении курсора мыши на кнопку Справка
на панели Геообработка.Примечание:
Если краткая информация задана в метаданных инструмента и в диалоговом окне Свойства, краткая информация из свойств инструмента будет отображаться в диалоговом окне инструмента.
- Использование - Основные подсказки или инструкции по корректному и эффективному использованию инструмента.
- Синтаксис - Специальная справка по каждому параметру, включая подходящие типы данных и значения.
В метаданных также можно указать примеры кода, сведения об авторах, ограничения использования и экстент.
Для документирования пользовательского инструмента геообработки и набора инструментов щелкните правой кнопкой мыши инструмент или набор инструментов и выберите Редактировать метаданные. Или щелкните правой кнопкой мыши инструмент или набор инструментов, выберите Просмотр метаданных и щелкните кнопку Редактировать 
на вкладке Каталог. После документирования пользовательского инструмента любой пользователь этого инструмента сможет получить справку по нему точно так же, как он получает справку по инструментам геообработки ArcGIS Pro.