Справка на основе комментариев не отображает содержимое в разделе .NOTES - PullRequest
0 голосов
/ 01 марта 2019

Согласно TechNet одно из ключевых слов для справки на основе комментариев - .Notes.Но когда я включаю это ключевое слово, соответствующий текст справки не отображается.

Мой скрипт:

<#
.DESCRIPTION
This describes the script.

.NOTES
This is a note about the script.
#>

"Hello world"

Вывод Get-Help:

PS E:\> Get-Help .\Test-Script.ps1

NAME
    E:\Test-Script.ps1

SYNOPSIS


SYNTAX
    E:\Test-Script.ps1 [<CommonParameters>]


DESCRIPTION
    This describes the script.


RELATED LINKS

REMARKS
    To see the examples, type: "get-help E:\Test-Script.ps1 -examples".
    For more information, type: "get-help E:\Test-Script.ps1 -detailed".
    For technical information, type: "get-help E:\Test-Script.ps1 -full".

I знать ключевое слово .Notes распознается, потому что, если я его неправильно напишу, скажем, как .NotesX, запуск Get-Help не вернет любую пользовательскую справку:

PS E:> Get-Help. \ Test-Script.ps1
Test-Script.ps1

Я искал пользовательский переключатель, который может потребоваться для Get-Help перед отображением этого раздела,например, -example показывает содержимое ключевых слов .Example, но не нашел его.Я пытаюсь это сделать в PowerShell v5.1.

Как получить раздел .Notes для отображения при запуске Get-Help?

1 Ответ

0 голосов
/ 01 марта 2019

См. Get-Help Get-Help

ЗАМЕЧАНИЯ

To see the examples, type: "get-help Get-Help -examples".
For more information, type: "get-help Get-Help -detailed".
For technical information, type: "get-help Get-Help -full".
For online help, type: "get-help Get-Help -online"

Так что вы можете использовать:

Get-Help .\Test-Script.ps1 -full
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...