Справка на основе комментариев PowerShell не работает для сценария

Question

Я пытаюсь реализовать справку на основе комментариев в написанном мной сценарии. Я пытался следовать всем документам и указаниям по этому вопросу, но не могу заставить его работать. Ниже приведен формат моего раздела справки на основе комментариев:

<#
.SYNOPSIS

Overview of my script

.DESCRIPTION

Description of my script

.EXAMPLE

Example #1

.EXAMPLE

Example #2
#>

Мой раздел param () начинается в третьей строке ниже #>. Когда я выполняю команду:

Get-Help -path .\Nameofmyscript.ps1

или

Get-Help -path .\Nameofmyscript.ps1 -full

, вывод будет, если я только что запустил

Get-Help

Answer 1

Вам необходимо использовать параметр -Name здесь для вашего скрипта:

Get-Help -Name .\Nameofmyscript.ps1

При передаче имени скрипта в -Name вам нужно будет включить полный или относительный путь, если скрипт не в пределах пути $env:Path.

Читая документацию для Get-Help , вы можете прочитать описание для -Name и -Path. -Name предназначен для командлета, функции, поставщика или сценария. -Path принимает путь провайдера, чтобы показать, как элемент, переданный в -Name, работает в данном провайдере. Как правило, вам не нужен -Path, если вы не загружаете указанный c файл справки для провайдера.