ReSharper Curiosity: “Thông số chỉ được sử dụng cho (các) kiểm tra điều kiện trước.”

Tại sao ReSharper lại đánh giá tôi về mã này?

    private Control GetCorrespondingInputControl(SupportedType supportedType, object settingValue)
    {
        this.ValidateCorrespondingValueType(supportedType, settingValue);

        switch(supportedType)
        {
            case SupportedType.String:
                return new TextBox { Text = (string)settingValue };
            case SupportedType.DateTime:
                return new MonthPicker { Value = (DateTime)settingValue, ShowUpDown = true };
            default:
                throw new ArgumentOutOfRangeException(string.Format("The supported type value, {0} has no corresponding user control defined.", supportedType));
        }
    }

    private void ValidateCorrespondingValueType(SupportedType supportedType, object settingValue)
    {
        Type type;

        switch(supportedType)
        {
            case SupportedType.String:
                type = typeof(string);
                break;
            case SupportedType.DateTime:
                type = typeof(DateTime);
                break;
            default:
                throw new ArgumentOutOfRangeException(string.Format("The supported type value, {0} has no corresponding Type defined.", supportedType));
        }
        string exceptionMessage = string.Format("The specified setting value is not assignable to the supported type, [{0}].", supportedType);
        if(settingValue.GetType() != type)
        {
            throw new InvalidOperationException(exceptionMessage);
        }
    }

Tham số "settingValue" của phương thức thứ hai ValidateCorresp Tương ứngValueType chuyển sang màu xám với thông báo sau của ReSharper: "Tham số 'settingValue' chỉ được sử dụng cho (các) kiểm tra điều kiện trước."

Nó không phán xét, nó đang cố gắng giúp đỡ :)

Nếu ReSharper thấy rằng một tham số chỉ được sử dụng như một phép kiểm tra để đưa ra một ngoại lệ, nó sẽ chuyển sang màu xám, cho thấy rằng bạn không thực sự sử dụng nó cho công việc "thực sự". Đây rất có thể là một sự nhầm lẫn - tại sao lại chuyển vào một tham số mà bạn không sử dụng? Nó thường chỉ ra rằng bạn đã sử dụng nó ở điều kiện trước, nhưng sau đó quên (hoặc không cần nữa) để sử dụng nó ở nơi khác trong mã.

Vì phương thức là một phương thức xác nhận (nghĩa là tất cả những gì nó làm là khẳng định nó hợp lệ), bạn có thể chặn thông báo bằng cách đánh dấu ValidateCorrespondingValueTypelà phương thức xác nhận, sử dụng các thuộc tính chú thích của ReSharper , cụ thể là [AssertionMethod]thuộc tính:

[AssertionMethod]
private void ValidateCorrespondingValueType(SupportedType supportedType, object settingValue)
{
  // …
}

Thật thú vị, ReSharper sẽ hỗ trợ nếu bạn sử dụng nameofchức năng mới trong C # 6:

static void CheckForNullParameters(IExecutor executor, ILogger logger)
{
    if (executor == null)
    {
        throw new ArgumentNullException(nameof(executor));
    }

    if (logger == null)
    {
        throw new ArgumentNullException(nameof(logger));
    }
}

Cách sau khắc phục sự cố (trong ReSharper 2016.1.1, VS2015), nhưng tôi không chắc nó giải quyết được vấn đề 'đúng'. Trong mọi trường hợp, nó cho thấy sự mơ hồ trong cơ chế của ReSharper liên quan đến chủ đề này:

Điều này dẫn đến cảnh báo:

    private void CheckForNull(object obj)
    {
        if (ReferenceEquals(obj, null))
        {
            throw new Exception();
        }
    }

Nhưng điều này không:

    private void CheckForNull(object obj)
    {
        if (!ReferenceEquals(obj, null))
        {
            return;
        }
        throw new Exception();
    }

Điều thú vị là mã tương đương (đảo ngược được thực hiện bởi ReSharper: D) cho kết quả khác nhau. Có vẻ như việc khớp mẫu đơn giản không chọn phiên bản thứ hai.

Giải pháp ưa thích của tôi cho vấn đề này là làm cho người bán lại nghĩ rằng tham số được sử dụng. Điều này có lợi thế hơn sử dụng một thuộc tính như UsedImplicitlybởi vì nếu bạn đã bao giờ làm dừng sử dụng tham số đó, resharper sẽ bắt đầu cảnh báo bạn một lần nữa. Nếu bạn sử dụng một thuộc tính, trình sạc lại cũng sẽ không nhận được các cảnh báo thực trong tương lai.

Một cách dễ dàng để khiến resharper nghĩ rằng paramter được sử dụng là thay thế throwbằng một method. Vì vậy, thay vì ...

if(myPreconditionParam == wrong)
    throw new Exception(...);

...bạn viết:

if(myPreconditionParam == wrong)
    new Exception(...).ThrowPreconditionViolation();

Điều này là độc đáo để tự ghi lại tài liệu cho các lập trình viên trong tương lai, và resharper sẽ thoát khỏi việc than vãn.

Việc thực hiện ThrowPreconditionViolation là không đáng kể:

public static class WorkAroundResharperBugs 
{
    //NOT [Pure] so resharper shuts up; the aim of this method is to make resharper 
    //shut up about "Parameter 'Foobaar' is used only for precondition checks" 
    //optionally: [DebuggerHidden]
    public static void ThrowPreconditionViolation(this Exception e)
    {
        throw e;
    }
}

Một phương thức mở rộng trên Exception là ô nhiễm không gian tên, nhưng nó khá kín.

Những người khác đã trả lời câu hỏi, nhưng không ai đề cập đến các cách tắt cảnh báo sau đây.

Thêm điều này bên trên chữ ký phương thức để tắt nó chỉ cho phương thức đó:

    // ReSharper disable once ParameterOnlyUsedForPreconditionCheck.Local

Thêm điều này vào phía trên khai báo lớp để tắt nó cho toàn bộ tệp:

     // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local