PowerShell中给函数参数设置帮助信息的例子
PowerShell中给函数参数设置帮助信息的例子
发布时间:2016-12-28 来源:查字典编辑
摘要:本文介绍在PowerShell创建自定义函数时,如何为必选参数设置帮助信息。下面这段代码,我们创建了一个test-function的函数。这...

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

下面这段代码,我们创建了一个test-function的函数。这个函数有一个参数p,它是必选参数。更进一步,我们为这个参数$p设置了一个helpMessage属性,这个属性的意思就是为这个必须参数提供帮助信息。因为是必选参数,所以在不输入值的情况下,函数是不会执行,而会提示为参数输入值的。如果用户不知道应该为这个参数输入什么值,那么这个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的信息,必须要在参数提示这里输入“!?”这两个字符。

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

推荐文章
猜你喜欢
附近的人在看
推荐阅读
拓展阅读
相关阅读
网友关注
最新PowerShell学习
热门PowerShell学习
脚本专栏子分类