New-UsageInfo

模块:: Microsoft.PowerShell.Crescendo Module

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

语法

Default （默认值）

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
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。