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

所属分类: 脚本专栏 / PowerShell 阅读数: 609
收藏 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函数必选参数设置帮助信息,本文就介绍这么多,希望对您有所帮助,谢谢!

更多精彩内容其他人还在看

Windows Powershell排序和分组管道结果

本文通过实例,详细介绍了Powershell如何对管道结果进行排序和分组,非常的实用,有需要的朋友可以参考下
收藏 0 赞 0 分享

Windows Powershell过滤管道结果

通过管道可以过滤某些对象和对象的属性,这个功能很实用,因为很多时候我们并不是对所有的结果感兴趣,可能只会对某些结果感兴趣。
收藏 0 赞 0 分享

Windows Powershell分析和比较管道结果

这篇文章主要介绍了Windows Powershell分析和比较管道结果,需要的朋友可以参考下
收藏 0 赞 0 分享

Powershell小技巧--将文件夹中的大文件分成若干份

这篇文章主要介绍了使用Powershell将文件夹中的大文件分成若干份的一段代码分享,非常实用,大家也可以根据需求自己来稍微调整下
收藏 0 赞 0 分享

Powershell小技巧--远程对比服务配置

这篇文章主要介绍了使用Powershell远程对比服务配置的方法,大家可以推广下获取服务器其他参数进行对比,希望对大家能有所帮助
收藏 0 赞 0 分享

Windows Powershell导出管道结果

本文主要讲诉了PowerShell的输出命令详细解释,以及导出管道结果的部分示例,非常有用,有需要的朋友可以参考下
收藏 0 赞 0 分享

Windows Powershell扩展类型系统

本文主要详细介绍了集中将对象转换成文本的方法,并附上示例说明,非常的实用,有需要的朋友可以参考下
收藏 0 赞 0 分享

Windows Powershell对象=属性+方法

从今天开始,我们这个系列的教程进入到讲诉使用对象的阶段,那么本阶段的第一篇还是先来熟悉下概念,简单的说对象=属性+方法
收藏 0 赞 0 分享

Windows Powershell属性:描述对象是什么

既然上文说明了对象=属性+方法,那么本文我们就先来探讨下属性。先从属性的概念入手,接着通过属性中包含对象、只读属性和读写属性、属性的类型、查看所有属性这4个方面详细向我们展示了对象。有需要的朋友展示下
收藏 0 赞 0 分享

Windows Powershell方法(对象能做什么)

方法定义了一个对象可以做什么事情。当你把一个对象输出在控制台时,它的属性可能会被转换成可视的文本。但是它的方法却不可见。
收藏 0 赞 0 分享
查看更多