如何在 PowerShell 函数中添加帮助?
powershellmicrosoft technologiessoftware & coding更新于 2026/2/10 4:22:17
编写程序时，非编程背景的人通常希望获得与程序相关的尽可能多的帮助。当我们编写函数并声明参数时，那些不知道参数需要什么输入的人通常会先使用 Get-Help 命令搜索帮助，但结果只能找到参数，而找不到参数的描述。例如
function TestFunct{
param(
#16 Digit Application ID
[parameter(Mandatory=$true)]
[String]$AppID,
#Date in the Unix Format - 2020-10-31T17:12:10+0530
[String]$Date
)
}
在上面的例子中，指定了两个参数，当用户获取函数帮助时，它没有指定参数描述的注释。例如:
PS C:\> help TestFunct -Parameter * -AppID <string> Required? true Position? 0 Accept pipeline input? false Parameter set name (All) Aliases None Dynamic? false -Date <string> Required? false Position? 1 Accept pipeline input? false Parameter set name (All) Aliases None Dynamic? false
要从评论中添加描述，我们需要添加基于评论的帮助，并且需要使用基于评论的帮助中的概要。
示例
function TestFunct{
<#
.SYNOPSIS
This is test function for parameter based help
#>
param(
#16 Digit Application ID
[parameter(Mandatory=$true)]
[String]$AppID,
#Date in the Unix Format - 2020-10-31T17:12:10+0530
[String]$Date
)
}
现在，当我们检查参数时，我们会得到基于注释的描述。
PS C:\> help TestFunct -Parameter * -AppID <String> 16 Digit Application ID Required? true Position? 1 Default value Accept pipeline input? false Accept wildcard characters? false -Date <String> Date in the Unix Format - 2020-10-31T17:12:10+0530 Required? false Position? 2 Default value Accept pipeline input? false Accept wildcard characters? false
