Question

我有一个powershell脚本，我希望能够显示help屏幕。到目前为止，它接受3个参数directoryURL loginprefix和validateOnly。

param(
    [Parameter(Mandatory=$true)]
    [string]$directoryUrl,

    #[Parameter(Mandatory=$true)]
    [string]$prependedPermissions,

    #[Parameter(Mandatory=$true)]
    [string]$validateOnly
);

我想检查某人是否在-help之类的任何地方输入.\scriptName.ps1 -help，它将能够显示在屏幕上。

我该怎么做？

Answer 1

这可能不是要走的路。

Powershell内置了非常好的文档功能。如果在脚本顶部添加以下文档注释，则只需键入help myscript.ps1即可获得帮助输出。

<#
    .SYNOPSIS
    Short description of this scripts purpose
    .PARAMETER directoryUrl
    The URL to the directory
    .PARAMETER prependedPermissions
    Prepended permissions
    .PARAMETER validateOnly
    Only validate
#>
param(
    [Parameter(Mandatory=$true)]
    [string]$directoryUrl,

    #[Parameter(Mandatory=$true)]
    [string]$prependedPermissions,

    #[Parameter(Mandatory=$true)]
    [string]$validateOnly
);

您可以在以下文章https://technet.microsoft.com/en-us/magazine/hh500719.aspx

中找到有关文档功能的更多信息

可选命令行args powershell

1 个答案: