CA1707:識別項名稱不應該包含底線
| 屬性 | 值 |
|---|---|
| 規則識別碼 | CA1707 |
| 職稱 | 識別項名稱不應該包含底線 |
| 類別 | 命名 |
| 修正程式是中斷或非中斷 | 中斷 - 在元件上引發時 非中斷 - 在類型參數上引發時 |
| 預設在 .NET 9 中啟用 | No |
原因
識別子的名稱包含底線 （_） 字元。
檔案描述
根據慣例，識別項名稱不包含底線 (_) 字元。 規則會檢查命名空間、類型、成員和參數。
命名慣例是以通用語言執行平台為目標的程式庫，提供一種通用的寫法。 如此一來，可縮短新軟體程式庫所需的學習曲線，並且因為程式庫是由具備開發受控程式碼專業知識的人員所開發，進而提升客戶的信賴感。
如何修正違規
從名稱中移除所有底線字元。
隱藏警告的時機
請勿隱藏生產程序代碼的警告。 不過，隱藏測試程式代碼的這個警告是安全的。
隱藏警告
如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。
#pragma warning disable CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707
[*.{cs,vb}]
dotnet_diagnostic.CA1707.severity = none
如需詳細資訊，請參閱 如何隱藏程式代碼分析警告。
對於目前使用底線且無法修改之Microsoft程序代碼中已知的方法，應該隱藏規則。
設定程式代碼以分析
使用下列選項來設定程式代碼基底要執行此規則的部分。
您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則，或針對它套用的所有規則設定此選項。 如需詳細資訊，請參閱 程式代碼品質規則組態選項。
包含特定 API 介面
您可以藉由設定 [api_surface] 選項，根據程式代碼基底的存取範圍，設定執行此規則的哪些部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：
dotnet_code_quality.CAXXXX.api_surface = private, internal
注意
以適用規則的標識碼取代 XXXX 的 CAXXXX 部分。
