Powershell 中未显示基于评论的帮助

Question

我正尝试在 Windows Server 2016 上使用 Powershell 5.1 实施 here 所述的基于评论的帮助。

我正在使用的脚本名为 blah。ps1:

<#
.DESCRIPTION
blah blah
#>
function Blahblah
{
}

在 Powershell 中，我可以加载脚本：

.\blah.ps1

但是当我使用以下方法寻求有关此功能的帮助时：

Get-Help Blahblah

Powershell 只报错：

Get-Help : Get-Help could not find Blahblah in a help file in this session. To download updated help topics type: "Update-Help". To get help online, search for the help topic in the TechNet library at http://go.microsoft.com/fwlink/?LinkID=107116.
At line:1 char:1
+ Get-Help Blahblah
+ ~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceUnavailable: (:) [Get-Help], HelpNotFoundException
    + FullyQualifiedErrorId : HelpNotFound,Microsoft.PowerShell.Commands.GetHelpCommand

我假设 Get-Help 可以与自定义帮助评论一起使用。我错过了什么？

Answer 1

将脚本作为模块而不是运行导入。

Import-Module .\blah.ps1

Answer 2

同时声明函数，包括紧跟在function header之后的帮助，将其保存在模块中，然后导入模块可能是最好的 处理它的方法，您可以通过确保...

使脚本的帮助对 Get-Help 可用

函数名和文件名匹配（这意味着每个文件一个函数），并且...
确保脚本文件位于 $env:PATH.

函数的帮助可以在函数本身之前声明，前提是帮助结束 #> 和函数声明开始之间的空行不超过一个。

请参阅 PowerShell 帮助或链接的 Microsoft 文档中的 Get-Help about_Comment_Based_Help。

Powershell 中未显示基于评论的帮助

Comment Based Help not displayed in Powershell

powershell

powershell-5.0