選擇診斷識別碼

診斷識別碼是與指定診斷相關聯的字串，例如編譯器錯誤或分析器所產生的診斷。

識別碼會從各種 API 浮出水面，例如：

• DiagnosticDescriptor.Id
• ObsoleteAttribute.DiagnosticId
• ExperimentalAttribute.DiagnosticId

診斷識別碼也會作為來源中的識別碼，例如，從 #pragma 警告停用或.editorconfig 檔案。

考量

• 診斷識別碼應是唯一的
• 診斷識別碼必須是 C# 中的合法識別碼
• 診斷識別碼長度應小於 15 個字元
• 診斷識別碼的格式應為 <PREFIX><number>
  • 前置詞專屬於您的專案
  • 數字代表特定的診斷

注意

這是變更診斷識別碼的來源中斷性變更，因為如果識別碼變更，則會忽略現有的隱藏。

請勿將您的前置詞限制為兩個字元 (例如 CSXXX 和 CAXXXX)。 請改用較長的前置詞來避免衝突。 例如，System.* 診斷會使用 SYSLIB 作為其前置詞。