编写 PowerShell 帮助时如何使用 .PARAMETER?
在编写函数帮助时,如何使用 .PARAMETER 选项添加函数参数的详细信息?我尝试了“.PARAMETER $ParamName”,但不起作用,我尝试了“.PARAMETER -ParamName”,也不起作用。
这是一个例子:
<#
.SYNOPSIS
short overview
.DESCRIPTION
longer overview
.PARAMETER
dont know how this works?
.EXAMPLE
Example code
.NOTES
This is awesome!
.LINK
http://winfred.com
#>
How do I use the .PARAMETER option to add detailed information for the parameters of a function when writing the help for it? I tried ".PARAMETER $ParamName", that didn't work, and I tried ".PARAMETER -ParamName", that didn't work either.
Here's an example:
<#
.SYNOPSIS
short overview
.DESCRIPTION
longer overview
.PARAMETER
dont know how this works?
.EXAMPLE
Example code
.NOTES
This is awesome!
.LINK
http://winfred.com
#>
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
![扫码二维码加入Web技术交流群](/public/img/jiaqun_03.jpg)
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
它并不复杂,您只需将其用作:
例如:
Its not complicated, you simply use it as:
For example: