PowerShell实例为函数参数设置帮助信息

发布时间:2019-09-19编辑:脚本学堂
本文介绍了powershell脚本编程中为函数参数设置帮助信息的方法,设置一个helpMessage属性,此属性为这个必须参数提供帮助信息,需要的朋友参考下。

在Powershell创建自定义函数时,如何为必选参数设置帮助信息?

创建了一个test-function的函数。这个函数有一个参数p,它是必选参数。更进一步,为这个参数$p设置了一个helpMessage属性,此属性为这个必须参数提供帮助信息。
因为是必选参数,所以在不输入值的情况下,函数是不会执行,而会提示为参数输入值的。(www.jb200.com 脚本学堂)
如果用户不知道应该为这个参数输入什么值,那么这个HelpMessage有可能帮倒忙。

例子:
 

复制代码 代码示例:
PS C:UsersHong> function Test-Function
>> {
>> param(
>> [Parameter(Mandatory=$true, HelpMessage='hahahaha')]
>> $p
>> )
>> "$p"
>> }
>>
PS C:UsersHong> Test-Function
 

位于命令管道位置 1 的 cmdlet Test-Function
请为以下参数提供值:
(请键入 !? 以查看帮助。)
p: !?
hahahaha
p:
注意,要想看到HelpMessage的信息,必须要在参数提示这里输入“!?”这两个字符。