通过

New-UsageInfo

  • 参考
模块:
Microsoft.PowerShell.Crescendo

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

语法

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

说明

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

示例

示例 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 用途的文本。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

输入

None

输出

Object