Parancsmag osztálydeklarációjaCmdlet Class Declaration

A Microsoft .NET-keretrendszer osztálya parancsmagként van deklarálva, ha a parancsmag attribútumot a osztály metaadataiként határozza meg.A Microsoft .NET Framework class is declared as a cmdlet by specifying the Cmdlet attribute as metadata for the class. (A parancsmag attribútum az egyetlen kötelező attribútum az összes parancsmag esetében).(The Cmdlet attribute is the only required attribute for all cmdlets). A parancsmag attribútum megadásakor meg kell adnia a parancsmagot a felhasználó számára azonosító ige-és főnévi párt.When you specify the Cmdlet attribute, you must specify the verb-and-noun pair that identifies the cmdlet to the user. Továbbá le kell írnia a parancsmag által támogatott Windows PowerShell-funkciókat.And, you must describe the Windows PowerShell functionality that the cmdlet supports. A parancsmag attribútum megadásához használt deklarációs szintaxissal kapcsolatos további információkért lásd: parancsmag-attribútum deklarációja.For more information about the declaration syntax that is used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.

Megjegyzés

A parancsmag attribútumot a System. Management. Automation. CmdletAttribute osztály határozza meg.The Cmdlet attribute is defined by the System.Management.Automation.CmdletAttribute class. Az osztály tulajdonságai az attribútum deklarálása során használt deklarációs paramétereknek felelnek meg.The properties of this class correspond to the declaration parameters that are used when you declare the attribute.

FőnevekNouns

A parancsmag főnéva meghatározza azokat az erőforrásokat, amelyeken a parancsmag működik.The noun of the cmdlet specifies the resources upon which the cmdlet acts. A főnév megkülönbözteti a parancsmagokat más parancsmagokból.The noun differentiates your cmdlets from other cmdlets.

A parancsmagok neveiben szereplő névnek egyedinek kell lennie, és általános nevek (például a kiszolgáló ) esetében érdemes egy rövid előtagot hozzáadni, amely megkülönbözteti az erőforrást más hasonló erőforrásokból.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. Például egy olyan parancsmag neve, amely egy előtaggal rendelkező főnévot tartalmaz Get-SQLServer .For example, a cmdlet name that includes a noun with a prefix is Get-SQLServer. Egy adott főnév egy általánosabb művelettel való kombinációja lehetővé teszi, hogy a felhasználó gyorsan megkeresse a parancsmagot a művelettel, majd a parancsmagot az erőforrása alapján azonosítsa, miközben elkerüli a szükségtelen parancsmagok nevének ismétlődését.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.

A parancsmagok nevében nem használható speciális karakterek listáját a szükséges fejlesztési irányelvekcímű részben tekintheti meg.For a list of special characters that cannot be used in cmdlet names, see Required Development Guidelines.

ParancsokVerbs

Amikor megad egy műveletet, a fejlesztési irányelvekhez a Windows PowerShell által biztosított előre definiált műveletek egyikét kell használnia.When you specify a verb, the development guidelines require you to use one of the predefined verbs provided by Windows PowerShell. Ezen előre definiált műveletek egyikének használatával biztosíthatja, hogy az Ön által írt parancsmagok és a Microsoft és mások által írt parancsmagok között konzisztensek legyenek.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. A "Get" művelet például az Adatlekérdezési parancsmagokhoz használatos.For example, the "Get" verb is used for cmdlets that retrieve data.

További információ a műveletek irányelveiről: parancsmag-műveletek nevei.For more information about guidelines for verbs, see Cmdlet Verb Names. A parancsmagok nevében nem használható speciális karakterek listáját a szükséges fejlesztési irányelvekcímű részben tekintheti meg.For a list of special characters that cannot be used in cmdlet names, see Required Development Guidelines.

A Windows PowerShell funkcióinak támogatásaSupporting Windows PowerShell Functionality

A parancsmag attribútum azt is lehetővé teszi, hogy a parancsmag támogassa a Windows PowerShell által biztosított általános funkciókat.The Cmdlet attribute also allows you to specify that your cmdlet supports some of the common functionality that is provided by Windows PowerShell. Ide tartozik a gyakori funkciók támogatása, például a felhasználói visszajelzés megerősítése (a ShouldProcess funkció támogatása) és a tranzakciók támogatása.This includes support for common functionality such as user feedback confirmation (referred to as support for the ShouldProcess feature) and support for transactions. (A tranzakciók támogatása a Windows PowerShell 2,0-ben jelent meg).(Support for transactions was introduced in Windows PowerShell 2.0).

A parancsmag attribútum megadásához használt deklarációs szintaxissal kapcsolatos további információkért lásd: parancsmag-attribútum deklarációja.For more information about the declaration syntax that is used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.

Parancsmag-osztály definíciójaCmdlet Class Definition

A következő kód egy GetProc-parancsmag osztályának definíciója.The following code is the definition for a GetProc cmdlet class. Figyelje meg, hogy Pascal ház van használatban, és az osztály neve tartalmazza a parancsmag utasításait és főnévi nevét.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

Pascal házPascal Casing

A parancsmagok neve esetén használja a Pascal burkolatot.When you name cmdlets, use Pascal casing. A Get-Item és a Get-ItemProperty parancsmagok például a megfelelő módszert mutatják a nagybetűk kiosztására a parancsmagok elnevezése esetén.For example, the Get-Item and Get-ItemProperty cmdlets show the correct way to use capitalization when you are naming cmdlets.

Lásd még:See Also

System. Management. Automation. CmdletAttributeSystem.Management.Automation.CmdletAttribute

CmdletAttribute nyilatkozatCmdletAttribute Declaration

Parancsmag-műveletek neveiCmdlet Verb Names

Windows PowerShell-parancsmag írásaWriting a Windows PowerShell Cmdlet

Windows PowerShell SDKWindows PowerShell SDK