Deklarace třídy rutiny

Třída Microsoft .NET Framework je deklarována jako rutina zadáním atributu Cmdlet jako metadat třídy. (Atribut Cmdlet je jediným povinným atributem pro všechny rutiny. Když zadáte atribut Cmdlet, musíte zadat pár sloveso-a-podstatné jméno, který identifikuje rutinu pro uživatele. A je nutné popsat funkci Windows PowerShell, kterou rutina podporuje. Další informace o syntaxi deklarace, která se používá k určení atributu rutiny, najdete v tématu Deklarace atributu rutiny.

Poznámka

Atribut Cmdlet je definován třídou System.Management.Automation.CmdletAttribute. Vlastnosti této třídy odpovídají parametrům deklarace, které se používají při deklaraci atributu.

Podstatná jména

Podstatné jméno rutiny určuje prostředky, na kterých rutina pracuje. Podstatné jméno odlišuje vaše rutiny od ostatních rutin.

Podstatné jména v názvech rutin musí být specifická a v případě obecných jmen, jako je například server, je nejlepší přidat krátkou předponu, která odlišuje váš prostředek od ostatních podobných prostředků. Například název rutiny, který obsahuje podstatné jméno s předponou , je Get-SQLServer . Kombinace konkrétního podstatného jména s obecnějším slovesem umožňuje uživateli rychle vyhledat rutinu podle své akce a pak identifikovat rutinu podle jejího prostředku a vyhnout se zbytečným duplikací názvů rutin.

Seznam speciálních znaků, které nelze použít v názvech rutin, najdete v tématu Required Development Guidelines.

Příkazy

Při zadávání slovesa vyžadují pokyny pro vývoj použití jednoho z předdefinovaných sloves poskytovaných příkazem Windows PowerShell. Pomocí jednoho z těchto předdefinovaných sloves zajistíte konzistenci mezi rutinami, které píšete, a rutinami napsanými Microsoftem a ostatními. Například příkaz "Get" se používá pro rutiny, které načítá data.

Další informace o pokynech pro příkazy najdete v tématu Názvy operací rutin. Seznam speciálních znaků, které nelze použít v názvech rutin, najdete v tématu Required Development Guidelines.

Podpora Windows PowerShell funkcí

Atribut Cmdlet také umožňuje určit, že vaše rutina podporuje některé běžné funkce poskytované rutinou Windows PowerShell. To zahrnuje podporu běžných funkcí, jako je potvrzení zpětné vazby uživatelů (označuje se jako podpora funkce ShouldProcess) a podpora transakcí. (Podpora transakcí byla zavedena ve Windows PowerShell 2.0).

Další informace o syntaxi deklarace, která se používá k určení atributu rutiny, najdete v tématu Deklarace atributu rutiny.

Definice třídy rutiny

Následující kód je definice třídy rutiny GetProc. Všimněte si, že se používá jazyk Pascal Casing a že název třídy obsahuje sloveso a podstatné jméno rutiny.

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

Pascal Casing

Při pojmevání rutin použijte jazyk Pascal Casing. Například rutiny a ukazují správný způsob použití velkých a velkých Get-Item písmen při vytváření názvů Get-ItemProperty rutin.

Viz také

System.Management.Automation.CmdletAttribute

CmdletAttribute – deklarace

Názvy rutin

Vytvoření rutiny Windows PowerShellu

Sada SDK Windows PowerShellu