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

所属分类: 脚本专栏 / PowerShell 阅读数: 593
收藏 0 赞 0 分享

本文介绍在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操作Excel、CSV详细介绍

这篇文章主要介绍了PowerShell操作Excel、CSV详解,本文比较深入的探讨了PowerShell中如何操作Excel及CSV,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell中显示隐藏文件的方法

这篇文章主要介绍了Powershell中显示隐藏文件的方法,本文使用是是Get-ChildItem检索文件,加上-Hidden参数就可以显示隐藏文件了,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell中iso8601格式日期和DateTime对象互转实例

这篇文章主要介绍了PowerShell中iso8601格式日期和DateTime对象互转实例,本文讲解了iso8601格式转换成DateTime对象、日期时间转换成iso8601格式两个方法,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell使用C#实现缩写路径

这篇文章主要介绍了Powershell使用C#实现缩写路径,缩写路径有时候是非常有用的,比如某些报表的路径太长会很难看,缩写后就会好看许多,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell截取字符串并添加省略号的例子

这篇文章主要介绍了Powershell截取字符串并添加省略号的例子,本文直接给出代码实例,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell读取本机注册表中的所有软件关联扩展名

这篇文章主要介绍了Powershell读取本机注册表中的所有软件关联扩展名,本文直接给出实现代码,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell实现按类型排序

这篇文章主要介绍了Powershell实现按类型排序,本文直接给出实现代码,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell中打开网页实例

这篇文章主要介绍了Powershell中打开网页实例,本文直接给出实现代码,需要的朋友可以参考下
收藏 0 赞 0 分享

PowerShell实现获取进程所有者

这篇文章主要介绍了PowerShell实现获取进程所有者,本文直接给出实现代码,需要的朋友可以参考下
收藏 0 赞 0 分享

Windows Powershell Foreach 循环

Foreach-object 为cmdlet命令,使用在管道中,对管道结果逐个处理,foreach为遍历集合的关键字。
收藏 0 赞 0 分享
查看更多