PowerShell中给函数参数设置帮助信息的例子
更新时间：2014年07月31日 10:53:58 作者：洪哥
这篇文章主要介绍了PowerShell中给函数参数设置帮助信息的例子,特别是给必选参数写一个说明,这样使用的人就会更加方便,需要的朋友可以参考下
本文介绍在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用变量累积记录错误的小技巧，非常的简单实用，有需要的朋友可以参考下2014-10-10
这篇文章主要介绍了使用Powershell获取注册表值的类型的小技巧。另外详细介绍了如何使用PowerShell读、写、删除注册表键值。非常的实用，有需要的朋友可以参考下2014-10-10
这篇文章主要介绍了Powershell访问SQL Server数据库代码实例,本文直接给出代码,使用时只需要替换数据库配置参数即可,需要的朋友可以参考下2014-11-11
这篇文章主要介绍了PowerShell把IP地址转换成二进制的方法,在一些IP判断的场合经常使用的小技巧,需要的朋友可以参考下2014-08-08
本文通过实例，详细介绍了Powershell如何对管道结果进行排序和分组，非常的实用，有需要的朋友可以参考下2014-09-09
PowerShell中的特殊变量$null介绍和创建多行注释小技巧
这篇文章主要介绍了PowerShell中的特殊变量$null介绍和创建多行注释小技巧,需要的朋友可以参考下2014-08-08
探索PowerShell (四) PowerShell的对象、格式与参数
本节将要给大家介绍一下PowerShell下的对象，基本格式以及参数。依然属于PowerShell的基础2012-12-12
这篇文章主要介绍了PowerShell判断某天是星期几的方法,本文以判断星期天为例子,需要的朋友可以参考下2014-08-08
PowerShell Out-File向只读文件写入内容的方法
这篇文章主要介绍了PowerShell Out-File向只读文件写入内容的方法,只需要加一个-Force参数即可,需要的朋友可以参考下2014-08-08
Powershell 是运行在windows机器上实现系统和应用程序管理自动化的命令行脚本环境。微软之所以将Powershell 定位为Power，并不是夸大其词，因为它完全支持对象。其可读性，易用性，可以位居当前所有shell之首。2014-08-08
最新评论