Справка по сценариям на основе комментариев Powershell - PullRequest
Новая
       74

Справка по сценариям на основе комментариев Powershell

0 голосов
/ 23 ноября 2018

Мне не удается получить доступ к справке на основе комментариев в моем сценарии.

Я использую следующую команду:

PS C:\MyDir> Get-Help .\do-something.ps1 -Full (do -thing.ps1 находится в MyDir).

Мой вопрос:

Должен ли я ожидать, что эта команда будет работать одинаково на панели консоли ISE, а также на консоли PS?

Я рассмотрел Документация Microsoft и дистилляция следующие.Я что-то пропустил?Существуют ли сценарии, когда справка на основе комментариев просто не работает?

PowerShell НЕ будет анализировать справку на основе комментариев для сценария, если:

  1. Раздел справки на основе комментариев начинается в первой строкесценария, или перед ним стоят только пустые строки.

  2. После раздела справки на основе комментариев есть как минимум две пустые строки, если за ним следует объявление функции.

  3. Файл сценария находится в каталоге, который находится в $ env: PATH.Вы должны использовать параметр -Path, если он не указан в $ env: Path.

  4. Используются только допустимые ключевые слова справки на основе комментариев.Если вы ошибетесь, команда Get-Help завершится с ошибкой без каких-либо ошибок.

  5. Команда Get-Help использует правильный синтаксис, например:

PS C:\MyDir> Get-Help .\do-something.ps1 -Full

Раздел справки на основе комментариев отформатирован правильно, например:

Расположен в верхней части файла сценария: 

<#
.SYNOPSIS
Does something.

.DESCRIPTION
Performs tasks and produces output.
#>

1 Ответ

0 голосов
/ 24 ноября 2018

Стоит ли ожидать, что эта команда будет работать одинаково на панели консоли ISE, а также на консоли PS?

Да.Справка на основе комментариев анализируется PowerShell (system.management.automation.dll), а не хостом.

Существуют ли сценарии, когда справка на основе комментариев просто не работает?

Справка на основе комментариев работает, только если скрипт может быть выполнен.Если политика выполнения или элемент управления приложения, такой как AppLocker, запрещает выполнение сценария или если в сценарии имеется синтаксическая ошибка, Get-Help не может отобразить справку на основе комментариев.

...