当前位置: 移动技术网 > IT编程>脚本编程>Shell > PowerShell中给函数参数设置帮助信息的例子

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

2017年12月08日  | 移动技术网IT编程  | 我要评论

本文介绍在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函数必选参数设置帮助信息,本文就介绍这么多,希望对您有所帮助,谢谢!

如对本文有疑问, 点击进行留言回复!!

相关文章:

验证码:
移动技术网