通过

New-UsageInfo

  • 参考
模块:
Microsoft.PowerShell.Crescendo

创建一个代表 Crescendo Usage 定义的 PowerShell 对象。

语法

New-UsageInfo
   [-usage] <String>
   [<CommonParameters>]

说明

创建一个代表 Crescendo Usage 定义的 PowerShell 对象。 可以将值分配给对象的属性。 生成的对象可以添加到命令对象的 Usage 属性，也可以将其转换为要在配置文件中插入的 JSON。 对象的 Synopsis 作为基于注释的帮助插入到模块 .SYNOPSIS 中，该关键字下为基于注释的帮助。

示例

示例 1 - 创建 Usage 对象并将其转换为 JSON

$usage = New-UsageInfo -usage 'This is a description for how to use the cmdlet.'
$usage | ConvertTo-Json

{
  "Synopsis": "This is a description for how to use the cmdlet.",
  "SupportsFlags": false,
  "HasOptions": false,
  "OriginalText": null
}

参数

-usage

描述 cmdlet 用途的文本。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:False
接受通配符:False

输入

None

输出

Object