Declaratie van cmdlet-klassen

Een Microsoft .NET Framework klasse wordt gedeclareerd als een cmdlet door het kenmerk Cmdlet op te geven als metagegevens voor de klasse . (Het kenmerk Cmdlet is het enige vereiste kenmerk voor alle cmdlets). Wanneer u het kenmerk Cmdlet opgeeft, moet u het werkwoord-en-zelfstandig naamwoord-paar opgeven dat de cmdlet identificeert voor de gebruiker. En u moet de functionaliteit Windows PowerShell de cmdlet ondersteunt. Zie Declaratie van het kenmerk Cmdletvoor meer informatie over de declaratiesyntaxis die wordt gebruikt om het kenmerk Cmdlet op te geven.

Notitie

Het kenmerk Cmdlet wordt gedefinieerd door de klasse System.Management.Automation.CmdletAttribute. De eigenschappen van deze klasse komen overeen met de declaratieparameters die worden gebruikt wanneer u het kenmerk declareer.

Zelfstandige naamwoorden

Het zelfstandig naamwoord van de cmdlet geeft de resources op waarop de cmdlet fungeert. Het zelfstandig naamwoord onderscheidt uw cmdlets van andere cmdlets.

Zelfstandige naamwoorden in cmdlet-namen moeten specifiek zijn. In het geval van algemene zelfstandige naamwoorden, zoals server, kunt u het beste een kort voorvoegsel toevoegen dat uw resource onderscheidt van andere vergelijkbare resources. Een cmdlet-naam die bijvoorbeeld een zelfstandig naamwoord met een voorvoegsel bevat, is Get-SQLServer . De combinatie van een specifiek zelfstandig naamwoord met een meer algemene werkwoord kan de gebruiker snel vinden van de cmdlet door de actie en vervolgens identificeren van de cmdlet door de resource, terwijl onnodige cmdlet naam duplicatie voorkomen.

Zie Required Development Guidelines (Vereiste ontwikkelingsrichtlijnen) voor een lijst met speciale tekens die niet kunnen worden gebruikt in cmdlet-namen.

Termen

Wanneer u een werkwoord opgeeft, moet u volgens de richtlijnen voor ontwikkeling een van de vooraf gedefinieerde werkwoorden van Windows PowerShell. Door een van deze vooraf gedefinieerde werkwoorden te gebruiken, zorgt u voor consistentie tussen de cmdlets die u schrijft en de cmdlets die door Microsoft en anderen zijn geschreven. De werkwoord 'Get' wordt bijvoorbeeld gebruikt voor cmdlets die gegevens ophalen.

Zie cmdlet werkwoordnamen voor meer informatie over richtlijnen voor werkwoorden. Zie Required Development Guidelines (Vereiste ontwikkelingsrichtlijnen) voor een lijst met speciale tekens die niet kunnen worden gebruikt in cmdlet-namen.

Ondersteuning voor Windows PowerShell functionaliteit

Met het kenmerk Cmdlet kunt u ook opgeven dat uw cmdlet een deel van de algemene functionaliteit ondersteunt die door de Windows PowerShell. Dit omvat ondersteuning voor algemene functionaliteit, zoals bevestiging van feedback van gebruikers (ook wel ondersteuning voor de functie ShouldProcess genoemd) en ondersteuning voor transacties. (Ondersteuning voor transacties is geïntroduceerd in Windows PowerShell 2.0).

Zie Declaratie van het kenmerk Cmdletvoor meer informatie over de declaratiesyntaxis die wordt gebruikt om het kenmerk Cmdlet op te geven.

Definitie van cmdlet-klasse

De volgende code is de definitie voor een GetProc-cmdlet-klasse. Merk op dat Er wordt gebruik gemaakt van Het casing-gebruik van Casing en dat de naam van de klasse het werkwoord en het zelfstandig naamwoord van de cmdlet bevat.

[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet

Casing van Casing

Wanneer u cmdlets een naam hebt gegeven, gebruikt u Casing van Pascal. De cmdlets en tonen bijvoorbeeld de juiste manier om hoofdlettergebruik te Get-Item Get-ItemProperty gebruiken wanneer u cmdlets een naam geeft.

Zie ook

System.Management.Automation.CmdletAttribute

CmdletAttribute-declaratie

Namen van cmdlet-woorden

Een Windows PowerShell-cmdlet schrijven

Windows PowerShell SDK