Question

According to 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".

我知道可以识别.Notes关键字，因为如果我拼错了，例如说为“ .NotesX”，则运行Get-Help不会返回 any 定制帮助：

PS E：>获取帮助。\ Test-Script.ps1
Test-Script.ps1

我在显示此部分之前寻找了Get-Help可能需要的自定义开关，例如-example显示了.Example关键字的内容，但没有找到。我正在PowerShell v5.1上尝试此操作。

运行Get-Help时如何显示.Notes部分？

Answer 1

请参见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

基于注释的帮助不会在.NOTES部分显示内容

1 个答案: