Question

我有一个简单的简单脚本：

function a-func {

}

<#
.Synopsis
  Testing Get-Help
#>
function another-func {

}

Get-Help another-func

我没有配备Powershell 3或4的机器进行仔细检查，但我似乎记得这在PS 5之前有效。在Powershell 5.0控制台中，这是输出：

C：\用户\管理员\文件\ WindowsPowerShell＆GT; \ testhelp.ps1 Get-Help：Get-Help无法在此帮助文件中找到another-func 会话。要下载更新的帮助主题，请键入：＆＃34; Update-Help＆＃34;。要得到在线帮助，在TechNet库中搜索帮助主题 http://go.microsoft.com/fwlink/?LinkID=107116。在 C：\用户\管理\文档\ WindowsPowerShell \ testhelp.ps1：13 焦炭：1 + Get-Help another-func + ~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo：ResourceUnavailable：（:) [Get-Help]，HelpNotFoundException + FullyQualifiedErrorId：HelpNotFound，Microsoft.PowerShell.Commands.GetHelpCommand

我尝试在函数之前和函数内部放置帮助注释。

这是Powershell 5中的回归，还是我做错了？目标是在脚本中基于每个功能获取帮助输出。

更多细节：

> $PSVersionTable.PSVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
5      0      10105  0

> [System.Environment]::OSVersion

Platform ServicePack Version    VersionString
-------- ----------- -------    -------------
 Win32NT             6.3.9600.0 Microsoft Windows NT 6.3.9600.0

Answer 1

基于注释的功能帮助可以显示在以下三个位置之一：

在函数主体的开头。
在函数主体的末尾。
在Function关键字之前。函数帮助的最后一行和Function关键字之间不能有多个空行。

关于此的Microsoft链接： https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-5.0

尝试：

function a-func {
}
function another-func {
<#
    .Synopsis
    Testing Get-Help
#>
}

将代码粘贴到powershell ISE中，突出显示功能并点击F8，然后在控制台窗格中运行以下命令：

PS> Get-Help another-func

**很抱歉，如果有任何格式问题，请通过我的手机回答

有没有办法让Powershell 5的Get-Help解析当前脚本？

1 个答案: