New-UsageInfo

모듈:: Microsoft.PowerShell.Crescendo Module

Crescendo 사용 정의를 나타내는 PowerShell 개체를 만듭니다.

구문

Default (기본값)

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

Description

Crescendo 사용 정의를 나타내는 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
Default value:	None
와일드카드 지원:	False
DontShow:	False

매개 변수 집합

(All)

Position:	0
필수:	True
파이프라인의 값:	False
속성 이름별 파이프라인의 값:	False
나머지 인수의 값:	False

CommonParameters

이 cmdlet은 일반적인 매개 변수인 -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction 및 -WarningVariable 매개 변수를 지원합니다. 자세한 내용은 about_CommonParameters를 참조하세요.