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 Out-File向只读文件写入内容的方法
这篇文章主要介绍了PowerShell Out-File向只读文件写入内容的方法,只需要加一个-Force参数即可,需要的朋友可以参考下2014-08-08PowerShell入门教程之PowerShell和Cmd命令行的关系?
这篇文章主要介绍了PowerShell入门教程之PowerShell和Cmd命令行的关系?本文讲解了PowerShell中的CMD命令、PowerShell与Cmd命令行的关系、Cmd命令行会被PowerShell替代吗等内容,需要的朋友可以参考下2014-10-10PowerShell连接SQL SERVER数据库进行操作的实现代码
这篇文章主要介绍了PowerShell连接SQL SERVER数据库进行操作的实现代码,需要的朋友可以参考下2016-11-11PowerShell查找分区中最大文件的方法(查找文件并按大小排序)
这篇文章主要介绍了PowerShell查找分区中最大文件的方法,查找文件并按占用空间排序,并用命令参数只输出比如10条,这样就可以快速找出一个目录、一个分区下的N个最大的文件,需要的朋友可以参考下2014-08-08
最新评论