MSTEST0056：使用 DisplayName 屬性作為測試方法的顯示名稱

原因

測試方法屬性使用字串建構子參數來取代屬性 DisplayName 。

規則描述

在指定測試方法的自訂顯示名稱時，你應該使用該 DisplayName 屬性，而不是將字串當作建構子參數傳遞。 在 MSTest 4.0 及之後版本中，字串建構子參數用於來源資訊（呼叫者檔案路徑），而非顯示名稱，這是與 MSTest 3.x 的重大改變。 使用該 DisplayName 屬性能確保您的程式碼正確運作，避免潛在混淆。

[TestClass]
public class TestClass
{
    [TestMethod("My Test Name")] // Violation
    public void TestMethod()
    {
        // Test code
    }
}

如何修正違規

將建構子參數替換為屬性 DisplayName 。

[TestClass]
public class TestClass
{
    [TestMethod(DisplayName = "My Test Name")]
    public void TestMethod()
    {
        // Test code
    }
}

隱藏警告的時機

請勿隱藏來自此規則的警告。 使用該 DisplayName 屬性是指定測試方法自訂顯示名稱的唯一方式。 如果你的意圖是明確傳遞呼叫者檔案路徑參數的值，而非設定顯示名稱，你可以抑制這個警告，但這很少需要。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

#pragma warning disable MSTEST0056
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0056

若要停用檔案、資料夾或項目的規則，請在none中將其嚴重性設為。

[*.{cs,vb}]
dotnet_diagnostic.MSTEST0056.severity = none

如需詳細資訊，請參閱 如何隱藏程式碼分析警告。