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

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

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

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

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

.SYNOPSIS

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

.DESCRIPTION

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

.PARAMETER <Parameter-Name>

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

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

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

.EXAMPLE

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

.INPUTS

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

.OUTPUTS

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

.NOTES

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

.LINK

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

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

.COMPONENT

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

.ROLE

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

.FUNCTIONALITY

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

.FORWARDHELPTARGETNAME <Command-Name>

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

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Указывает категорию справки элемента в .FORWARDHELPTARGETNAME. Допустимые значения: Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filterили All. Используйте это ключевое слово, чтобы избежать конфликтов при наличии команд с тем же именем.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

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

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

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

# .EXTERNALHELP <XML Help File>

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

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

Если функция экспортируется модулем, задайте значение ключевого слова .EXTERNALHELP в имя файла без пути. Get-Help ищет указанное имя файла в подкаталоге для конкретного языка каталога модуля. Нет требований к имени XML-файла справки для функции. Начиная с PowerShell 5.0 функции, экспортируемые модулем, можно задокументировать в файле справки, который называется для модуля. Не нужно использовать .EXTERNALHELP ключевое слово примечания. Например, если Test-Function функция экспортируется MyModule модулем, можно указать файл MyModule-help.xmlсправки. Командлет Get-Help ищет справку по Test-Function функции в файле в MyModule-help.xml каталоге модуля.

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

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