Deklaracja klasy polecenia cmdletCmdlet Class Declaration

Klasa struktury Microsoft .NET jest zadeklarowana jako polecenie cmdlet przez określenie atrybutu cmdlet jako metadanych dla klasy.A Microsoft .NET Framework class is declared as a cmdlet by specifying the Cmdlet attribute as metadata for the class. (Atrybut cmdlet jest jedynym wymaganym atrybutem dla wszystkich poleceń cmdlet).(The Cmdlet attribute is the only required attribute for all cmdlets). Po określeniu atrybutu cmdlet należy określić parę czasownik-i-rzeczownik, która identyfikuje polecenie cmdlet dla użytkownika.When you specify the Cmdlet attribute, you must specify the verb-and-noun pair that identifies the cmdlet to the user. I należy opisać funkcje programu Windows PowerShell obsługiwane przez polecenie cmdlet.And, you must describe the Windows PowerShell functionality that the cmdlet supports. Aby uzyskać więcej informacji na temat składni deklaracji, która jest używana do określania atrybutu cmdlet , zobacz Deklaracja atrybutu polecenia cmdlet.For more information about the declaration syntax that is used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.

Uwaga

Atrybut polecenia cmdlet jest definiowany przez klasę System. Management. Automation. cmdletattribute .The Cmdlet attribute is defined by the System.Management.Automation.CmdletAttribute class. Właściwości tej klasy odpowiadają parametrom deklaracji, które są używane podczas deklarowania atrybutu.The properties of this class correspond to the declaration parameters that are used when you declare the attribute.

RzeczownikiNouns

Rzeczownik polecenia cmdlet określa zasoby, na których działa polecenie cmdlet.The noun of the cmdlet specifies the resources upon which the cmdlet acts. Rzeczownik odróżnia polecenia cmdlet od innych poleceń cmdlet.The noun differentiates your cmdlets from other cmdlets.

Rzeczowniki w nazwach poleceń cmdlet muszą być specyficzne i w przypadku rodzajowych rzeczowników, takich jak serwer, najlepiej jest dodać krótki prefiks odróżniający zasób od innych podobnych zasobów.Nouns in cmdlet names must be specific, and in the case of generic nouns, such as server, it is best to add a short prefix that differentiates your resource from other similar resources. Na przykład nazwa polecenia cmdlet, która zawiera rzeczownik z prefiksem to Get-SQLServer .For example, a cmdlet name that includes a noun with a prefix is Get-SQLServer. Połączenie określonej rzeczownika z bardziej ogólnym zleceniem pozwala użytkownikowi szybko zlokalizować polecenie cmdlet przez jego akcję, a następnie zidentyfikować polecenie cmdlet według jego zasobu, unikając niepotrzebne duplikowania nazw poleceń cmdlet.The combination of a specific noun with a more general verb enables the user to quickly locate the cmdlet by its action and then identify the cmdlet by its resource while avoiding unnecessary cmdlet name duplication.

Lista znaków specjalnych, które nie mogą być używane w nazwach poleceń cmdlet, znajduje się w temacie wymagane wskazówki dotyczące programowania.For a list of special characters that cannot be used in cmdlet names, see Required Development Guidelines.

zleceniaVerbs

Po określeniu zlecenia wskazówki dotyczące programowania wymagają użycia jednego ze wstępnie zdefiniowanych zleceń dostarczonych przez program Windows PowerShell.When you specify a verb, the development guidelines require you to use one of the predefined verbs provided by Windows PowerShell. Przy użyciu jednego z tych wstępnie zdefiniowanych zleceń można zapewnić spójność między wpisanymi poleceniami cmdlet i poleceniami cmdlet napisanymi przez firmę Microsoft i innych.By using one of these predefined verbs, you will ensure consistency between the cmdlets that you write and the cmdlets that are written by Microsoft and by others. Na przykład czasownik "Get" jest używany dla poleceń cmdlet, które pobierają dane.For example, the "Get" verb is used for cmdlets that retrieve data.

Aby uzyskać więcej informacji na temat wytycznych dotyczących zleceń, zobacz nazwy zleceń poleceń cmdlet.For more information about guidelines for verbs, see Cmdlet Verb Names. Lista znaków specjalnych, które nie mogą być używane w nazwach poleceń cmdlet, znajduje się w temacie wymagane wskazówki dotyczące programowania.For a list of special characters that cannot be used in cmdlet names, see Required Development Guidelines.

Obsługa funkcji programu Windows PowerShellSupporting Windows PowerShell Functionality

Atrybut cmdlet umożliwia również określenie, że polecenie cmdlet obsługuje niektóre typowe funkcje zapewniane przez program Windows PowerShell.The Cmdlet attribute also allows you to specify that your cmdlet supports some of the common functionality that is provided by Windows PowerShell. Obejmuje to obsługę typowych funkcji, takich jak potwierdzenie opinii użytkowników (określane jako Obsługa funkcji ShouldProcess) i obsługa transakcji.This includes support for common functionality such as user feedback confirmation (referred to as support for the ShouldProcess feature) and support for transactions. (Obsługa transakcji została wprowadzona w programie Windows PowerShell 2,0).(Support for transactions was introduced in Windows PowerShell 2.0).

Aby uzyskać więcej informacji na temat składni deklaracji, która jest używana do określania atrybutu cmdlet , zobacz Deklaracja atrybutu polecenia cmdlet.For more information about the declaration syntax that is used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.

Definicja klasy poleceń cmdletCmdlet Class Definition

Poniższy kod jest definicją klasy poleceń cmdlet getproc.The following code is the definition for a GetProc cmdlet class. Zauważ, że użyta jest wielkość liter w języku Pascal i że nazwa klasy zawiera czasownik i rzeczownik polecenia cmdlet.Notice that Pascal casing is used and that the name of the class includes the verb and noun of the cmdlet.

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

Wielkość liter w języku PascalPascal Casing

Podczas nazwy poleceń cmdlet Użyj wielkości liter w języku Pascal.When you name cmdlets, use Pascal casing. Na przykład Get-Item Get-ItemProperty polecenia cmdlet i pokazują poprawny sposób użycia wielkich liter podczas nazywania poleceń cmdlet.For example, the Get-Item and Get-ItemProperty cmdlets show the correct way to use capitalization when you are naming cmdlets.

Zobacz teżSee Also

System. Management. Automation. CmdletattributeSystem.Management.Automation.CmdletAttribute

Deklaracja poleceń cmdletCmdletAttribute Declaration

Nazwy czasowników poleceń cmdletCmdlet Verb Names

Pisanie polecenia cmdlet programu Windows PowerShellWriting a Windows PowerShell Cmdlet

Windows PowerShell SDKWindows PowerShell SDK