PowerShell中给函数参数设置帮助信息的例子

2020-10-29 21:07:55

字体：大中小

来源：转载

供稿：网友

本文介绍在PowerShell创建自定义函数时，如何为必选参数设置帮助信息。

下面这段代码，我们创建了一个test-function的函数。这个函数有一个参数p，它是必选参数。更进一步，我们为这个参数$p设置了一个helpMessage属性，这个属性的意思就是为这个必须参数提供帮助信息。因为是必选参数，所以在不输入值的情况下，函数是不会执行，而会提示为参数输入值的。如果用户不知道应该为这个参数输入什么值，那么这个HelpMessage有可能帮到忙。

复制代码代码如下:

PS C:/Users/Hong> function Test-Function
>> {
>> param(
>> [Parameter(Mandatory=$true, HelpMessage='hahahaha')]
>> $p
>> )
>> "$p"
>> }
>>
PS C:/Users/Hong> Test-Function

位于命令管道位置 1 的 cmdlet Test-Function
请为以下参数提供值:
(请键入 !? 以查看帮助。)
p: !?
hahahaha
p:

上面要注意一下，要想看到HelpMessage的信息，必须要在参数提示这里输入“!?”这两个字符。

关于为PowerShell函数必选参数设置帮助信息，本文就介绍这么多，希望对您有所帮助，谢谢！

上一篇：PowerShell函数参数指定数据类型实例

下一篇：PowerShell函数中使用必选参数实例