共用方式為


型別成員名稱

更新:2007 年 11 月

型別包含下列的成員類型:

  • 方法

  • 屬性

  • 欄位

  • 事件

本章節中的方針將協助類別庫設計人員選取與 .NET Framework 一致的成員名稱。

方法的名稱

要提供動詞命令或動詞命令片語的方法名稱。

一般來說,方法會在資料上作業,所以使用動詞命令來描述方法的動作可讓開發人員更容易瞭解方法的工作。當定義方法所執行的動作時,請務必要謹慎選取開發人員觀點中覺得明確的名稱。請勿選取一個描述方法如何執行其工作的動詞命令;換句話說,請勿針對方法名稱使用實作的細節。

屬性的名稱

要使用名詞、名詞片語或形容詞來命名屬性。

為屬性使用名詞片語或形容詞來命名是適合的方式,因為屬性可保存資料。

不要使用符合 Get 方法名稱的屬性。

例如,不要將屬性命名為 EmployeeRecord 並同時將方法命名為 GetEmployeeRecord,開發人員將無法知道要使用哪一個成員來完成程式設計工作。

請考慮為屬性提供與其型別相同的名稱。

當您的屬性對於列舉型別是強型別時,此屬性的名稱可以與此列舉型別的名稱相同。例如,如果您的列舉型別名為 CacheLevel,則傳回它的一個值的屬性也可命名為 CacheLevel。

事件的名稱

要在事件處理常式簽章中使用兩個名為 sender 和 e 的參數。

sender 參數應該具有 Object 的型別,而 e 參數應該是 EventArgs 的執行個體,或從它繼承而來。

欄位的名稱

欄位的命名方針適用於靜態公用欄位和受保護欄位;您不應該定義公用或受保護的執行個體欄位。如需詳細資訊,請參閱欄位設計

不要在欄位名稱上使用前置詞。例如,不要使用 g_ 或 s_ 來區別靜態和非靜態的欄位。

Portions Copyright 2005 Microsoft Corporation.All rights reserved.

Portions Copyright Addison-Wesley Corporation.All rights reserved.

如需設計方針的詳細資訊,請參閱由 Krzysztof Cwalina 和 Brad Abrams 所著,並由 Addison-Wesley 於 2005 年發行的「Framework 設計方針:可重複使用之 .NET 程式庫的慣例、慣用語法和模式」一書。

請參閱

其他資源

開發類別庫的設計方針

命名方針