Cmdlet 類別宣告

Microsoft .NET Framework 類別會將 Cmdlet 屬性指定為類別的中繼資料，以宣告為 Cmdlet。 (Cmdlet 屬性是) 的所有 Cmdlet 唯一必要的屬性。 當您指定 Cmdlet 屬性時，您必須指定用來識別 Cmdlet 給使用者的動詞和名詞配對。 而且，您必須描述 Cmdlet 支援的 Windows PowerShell 功能。 如需用來指定 Cmdlet 屬性之宣告語法的詳細資訊，請參閱 Cmdlet 屬性聲明。

注意

Cmdlet 屬性是由 CmdletAttribute類別所定義。 這個類別的屬性會對應至宣告屬性時所使用的宣告參數。

名詞

指令程式的名詞會指定 Cmdlet 作用的資源。 名詞會區分您的 Cmdlet 與其他 Cmdlet。

Cmdlet 名稱中的名詞必須是特定的，而且如果是一般名詞（例如 伺服器），最好新增簡短的前置詞，以區分您的資源與其他類似的資源。 例如，包含具有前置詞之名詞的 Cmdlet 名稱為 Get-SQLServer 。 具有更一般動詞的特定名片語合可讓使用者透過其動作快速找出 Cmdlet，然後依其資源識別 Cmdlet，同時避免不必要的 Cmdlet 名稱重複。

如需無法在 Cmdlet 名稱中使用的特殊字元清單，請參閱 必要的開發指導方針。

動詞

當您指定動詞時，開發指導方針會要求您使用 Windows PowerShell 所提供的其中一個預先定義動詞。 藉由使用其中一個預先定義的動詞，您將可確保您所撰寫的 Cmdlet 和由 Microsoft 和其他人撰寫的 Cmdlet 之間的一致性。 例如，"Get" 動詞命令會用於取出資料的 Cmdlet。

如需動詞指導方針的詳細資訊，請參閱 Cmdlet 動詞命令名稱。 如需無法在 Cmdlet 名稱中使用的特殊字元清單，請參閱 必要的開發指導方針。

支援 Windows PowerShell 功能

Cmdlet 屬性也可讓您指定 Cmdlet 支援 Windows PowerShell 所提供的一些常見功能。 這包括對一般功能的支援，例如使用者意見確認 (稱為 ShouldProcess 功能的支援) 和交易支援。 Windows PowerShell 2.0) 引進了 (的交易支援。

如需用來指定 Cmdlet 屬性之宣告語法的詳細資訊，請參閱 Cmdlet 屬性聲明。

Cmdlet 類別定義

下列程式碼是 GetProc Cmdlet 類別的定義。 請注意，會使用 Pascal 大小寫，而且類別的名稱包括 Cmdlet 的動詞和名詞。

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

Pascal 大小寫

當您命名 Cmdlet 時，請使用 Pascal 大小寫。 例如， Get-Item Get-ItemProperty 當您命名 Cmdlet 時，和 Cmdlet 會顯示使用大寫的正確方式。

另請參閱

CmdletAttribute。

CmdletAttribute 宣告

Cmdlet 動詞名稱

撰寫 Windows PowerShell Cmdlet

Windows PowerShell SDK