命名規則
命名規則支援 .NET 設計指導方針 的命名慣例。
在本節中
規則 | 描述 |
---|---|
CA1700:請勿將列舉值命名為 『Reserved』 | 此規則假設名稱包含「保留」的列舉成員目前未使用,而是作為未來版本中重新命名或移除的佔位符。 重新命名或移除成員是重大變更。 |
CA1707:識別碼不應包含底線 | 依照慣例,標識碼名稱不包含底線 (_) 字元。 此規則會檢查命名空間、類型、成員和參數。 |
CA1708:標識符應該具備超出大小寫的區別 | 命名空間、類型、成員和參數的識別碼不能僅因大小寫的差異而不同,因為針對 Common Language Runtime 的語言不需要區分大小寫。 |
CA1710:標識符應具有正確的後綴 | 根據慣例,擴充特定基底型別或實作特定介面或衍生自這些型別之型別的型別名稱,具有與基底型別或介面相關聯的後綴。 |
CA1711:標識符不應該有不正確的後綴 | 依照慣例,只有擴充特定基底類型或實作特定介面的類型名稱,或衍生自這些型別的類型,應該以特定的保留後綴結尾。 其他類型名稱不應該使用這些保留的後綴。 |
CA1712:請勿在類型名稱為列舉值前面加上前置詞 | 列舉成員的名稱前面不會加上類型名稱,因為開發工具預期會提供類型資訊。 |
CA1713:事件不應該加上 'before' 或 'after' 的前綴詞 | 事件的名稱會以 「Before」 或 「After」 開頭。 若要命名在特定序列中引發的相關事件,請使用目前或過去時態來指出動作序列中的相對位置。 |
CA1714:旗標列舉應具有複數名稱 | 公用列舉具有 System.FlagsAttribute 屬性,且其名稱不會以 “s” 結尾。 使用 FlagsAttribute 標記的類型具有複數的名稱,因為 屬性表示可以指定多個值。 |
CA1715:標識符應具有正確的前置詞 | 外部可見介面的名稱不會以大寫 「I」 開頭。 外部可見型別或方法上的泛型型別參數名稱不會以大寫 「T」 開頭。 |
CA1716:標識符不應符合關鍵詞 | 命名空間名稱或類型名稱符合程式設計語言中的保留關鍵詞。 命名空間和類型的標識碼不應符合以 Common Language Runtime 為目標的語言所定義的關鍵詞。 |
CA1717:只有 FlagsAttribute 列舉應該有複數名稱 | 命名慣例規定列舉的複數名稱表示可以同時指定一個以上的列舉值。 |
CA1720:識別元不應包含類型名稱 | 外部可見成員中的參數名稱包含數據類型名稱,或外部可見成員的名稱包含語言特定的數據類型名稱。 |
CA1721:屬性名稱不應與存取方法相同 | 公用或受保護成員的名稱應以「Get」開頭,如果不是,則其名稱應該與公用或受保護屬性相符。 “Get” 方法和屬性應該具有清楚區分其功能的名稱。 |
CA1724:類型名稱不應符合命名空間 | 類型名稱不應符合 .NET 命名空間的名稱。 違反此規則可減少連結庫的可用性。 |
CA1725:參數名稱應該符合基底宣告 | 覆寫階層中參數的一致命名會增加方法覆寫的可用性。 衍生方法中的參數名稱,與基底宣告中的名稱不同,可能會導致方法是否為基底方法的覆寫或方法的新多載造成混淆。 |
CA1727:針對具名佔位元使用PascalCase | 在記錄訊息範本中,針對具名佔位元使用PascalCase。 |