ключевые слова справки Comment-Based

В этом разделе перечислены ключевые слова в справке на основе комментариев.

Ключевые слова в справке Comment-Based

Ниже приведены допустимые ключевые слова справки на основе комментариев. Они перечислены в порядке, в котором они обычно отображаются в разделе справки вместе с их предполагаемым использованием. Эти ключевые слова могут отображаться в любом порядке в справке на основе комментариев, и они не учитывает регистр.

Обратите внимание, что ключевое слово .EXTERNALHELP имеет приоритет над всеми другими ключевыми словами справки на основе комментариев. При наличии .EXTERNALHELP командлет Get-Help не отображает справку на основе комментариев, даже если он не может найти файл справки, соответствующий значению ключевого слова.

.SYNOPSIS

Краткое описание функции или скрипта. Это ключевое слово можно использовать только один раз в каждом разделе.

.DESCRIPTION

Подробное описание функции или скрипта. Это ключевое слово можно использовать только один раз в каждом разделе.

.PARAMETER <Parameter-Name>

Описание параметра. Вы можете включить ключевое слово .PARAMETER для каждого параметра в функцию или скрипт.

Ключевые слова .PARAMETER могут отображаться в любом порядке в блоке комментариев, но порядок отображения параметров в инструкции Param или объявлении функции определяет порядок отображения параметров в разделе справки. Чтобы изменить порядок параметров в разделе справки, измените порядок параметров в операторе Param или объявлении функции.

Можно также указать описание параметра, разместив комментарий в инструкции Param непосредственно перед именем переменной параметра. Если вы используете как комментарий Param инструкции, так и ключевое слово .PARAMETER, используется описание, связанное с ключевым словом .PARAMETER, и комментарий оператора Param игнорируется.

.EXAMPLE

Пример команды, которая использует функцию или скрипт, а также пример выходных данных и описание. Повторите это ключевое слово для каждого примера.

.INPUTS

Типы объектов Microsoft .NET Framework, которые можно передать в функцию или скрипт. Можно также включить описание входных объектов.

.OUTPUTS

Тип .NET Framework объектов, возвращаемых командлетом. Можно также включить описание возвращаемых объектов.

.NOTES

Дополнительные сведения о функции или скрипте.

.LINK

Имя связанного раздела. Повторите это ключевое слово для каждого связанного раздела. Это содержимое отображается в разделе "Связанные ссылки" раздела справки.

Содержимое ключевого слова .LINK также может включать универсальный идентификатор ресурса (URI) в веб-версию той же статьи справки. Веб-версия открывается при использовании параметра OnlineGet-Help. Универсальный код ресурса (URI) должен начинаться с http или https.

.COMPONENT

Имя технологии или функции, которая использует функцию или скрипт или к которой она связана. Параметр ComponentGet-Help использует это значение для фильтрации результатов поиска, возвращаемых Get-Help.

.ROLE

Имя роли пользователя для раздела справки. Параметр RoleGet-Help использует это значение для фильтрации результатов поиска, возвращаемых Get-Help.

.FUNCTIONALITY

Ключевые слова, описывающие предполагаемое использование функции. Параметр FunctionalityGet-Help использует это значение для фильтрации результатов поиска, возвращаемых Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

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

.FORWARDHELPCATEGORY <Category>

Указывает категорию справки элемента в .FORWARDHELPTARGETNAME. Используйте это ключевое слово, чтобы избежать конфликтов при наличии команд с тем же именем.

Допустимые значения:

• Псевдоним
• Командлет
• HelpFile
• Function
• Provider
• General
• FAQ
• Glossary
• ScriptCommand
• ExternalScript
• Фильтр
• Все

.REMOTEHELPRUNSPACE <PSSession-variable>

Указывает сеанс, содержащий раздел справки. Введите переменную, содержащую PSSession. Это ключевое слово используется командлетом Export-PSSession для поиска разделов справки для экспортированных команд.

.EXTERNALHELP <XML Help File>

Указывает путь и /или имя XML-файла справки для скрипта или функции.

Ключевое слово .EXTERNALHELP сообщает командлету Get-Help получить справку по скрипту или функции в XML-файле. Ключевое слово .EXTERNALHELP требуется при использовании XML-файла справки для скрипта или функции. Без него Get-Help не найдете файл справки для функции или скрипта.

Ключевое слово .EXTERNALHELP имеет приоритет над всеми другими ключевыми словами справки на основе комментариев. При наличии .EXTERNALHELP командлет Get-Help не отображает справку на основе комментариев, даже если он не может найти файл справки, соответствующий значению ключевого слова.

При экспорте функции модулем скрипта значение .EXTERNALHELP должно быть именем файла без пути. Get-Help ищет файл в подкаталоге конкретного языкового стандарта каталога модуля. Нет требований к имени файла, но рекомендуется использовать следующий формат имени файла: <ScriptModule>.psm1-help.xml.

Если функция не связана с модулем, добавьте путь и имя файла в значение ключевого слова .EXTERNALHELP. Если указанный путь к XML-файлу содержит подкаталогы, зависящие от пользовательского интерфейса, Get-Help выполняет поиск подкаталогов рекурсивно для XML-файла с именем скрипта или функции в соответствии с языковыми стандартами, установленными для Windows, так же, как и для всех разделов справки на основе XML.

Дополнительные сведения о формате файла справки на основе XML командлетов см. в справке по командлету Windows PowerShell.