ReSharper Curiosity:“ พารามิเตอร์ใช้สำหรับการตรวจสอบเงื่อนไขเบื้องต้นเท่านั้น”

ทำไม ReSharper ถึงตัดสินฉันสำหรับรหัสนี้

    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);
        }
    }

วิธีที่สองพารามิเตอร์ "settingValue" ของ ValidateCorrespondingValueType เป็นสีเทาพร้อมข้อความต่อไปนี้โดย ReSharper: "พารามิเตอร์" settingValue "ใช้สำหรับการตรวจสอบเงื่อนไขเบื้องต้นเท่านั้น"

ไม่ได้ตัดสิน แต่พยายามช่วย :)

หาก ReSharper เห็นว่ามีการใช้พารามิเตอร์เป็นเช็คเพื่อโยนข้อยกเว้นเท่านั้นพารามิเตอร์นั้นจะเป็นสีเทาแสดงว่าคุณไม่ได้ใช้พารามิเตอร์นี้สำหรับงาน "จริง" จริงๆ นี่อาจเป็นข้อผิดพลาด - ทำไมต้องส่งพารามิเตอร์ที่คุณจะไม่ใช้? โดยปกติจะระบุว่าคุณเคยใช้งานในสภาพก่อน แต่ลืมไปแล้ว (หรือไม่จำเป็นต้องใช้อีกต่อไป) เพื่อใช้ที่อื่นในรหัส

เนื่องจากวิธีนี้เป็นวิธีการยืนยัน (นั่นคือทั้งหมดที่ทำก็คือยืนยันว่าถูกต้อง) คุณสามารถระงับข้อความโดยทำเครื่องหมายValidateCorrespondingValueTypeเป็นวิธีการยืนยันโดยใช้แอตทริบิวต์คำอธิบายประกอบของ ReSharper โดยเฉพาะ[AssertionMethod]แอตทริบิวต์:

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

ที่น่าสนใจคือ ReSharper จะปิดการใช้งานหากคุณใช้nameofฟังก์ชันใหม่ใน 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));
    }
}

ต่อไปนี้แก้ไขปัญหาได้ (ใน ReSharper 2016.1.1, VS2015) แต่ฉันไม่แน่ใจว่าจะแก้ปัญหาที่ "ถูกต้อง" ได้ ไม่ว่าในกรณีใดมันแสดงให้เห็นถึงความคลุมเครือในกลไกของ ReSharper เกี่ยวกับหัวข้อนี้:

สิ่งนี้ให้คำเตือน:

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

แต่สิ่งนี้ไม่:

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

เป็นที่น่าสนใจว่าโค้ดที่เทียบเท่า (การผกผันทำโดย ReSharper: D) ให้ผลลัพธ์ที่แตกต่างกัน ดูเหมือนว่าการจับคู่รูปแบบจะไม่ได้รับเวอร์ชันที่สอง

วิธีการแก้ปัญหาที่ต้องการของฉันที่จะแก้ไขปัญหานี้คือทำให้ resharper คิดว่าพารามิเตอร์เป็นสินค้า สิ่งนี้มีข้อได้เปรียบเหนือการใช้แอตทริบิวต์เช่นUsedImplicitlyหากคุณไม่เคย ใช้พารามิเตอร์นั้น resharper จะเริ่มเตือนคุณอีกครั้ง หากคุณใช้แอตทริบิวต์ resharper จะไม่ได้รับคำเตือนจริงในอนาคตเช่นกัน

วิธีง่ายๆในการทำให้ resharper คิดว่าใช้พารามิเตอร์คือการแทนที่throwด้วยวิธีการ ดังนั้นแทนที่จะ ...

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

...ที่คุณเขียน:

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

นี่เป็นเอกสารในตัวเองสำหรับโปรแกรมเมอร์ในอนาคตและ resharper ก็จะไม่ส่งเสียงหอน

การใช้ ThrowPreconditionViolation เป็นเรื่องเล็กน้อย:

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;
    }
}

วิธีการขยายข้อยกเว้นคือเนมสเปซมลพิษ แต่มีอยู่พอสมควร

คนอื่น ๆ ได้ตอบคำถามแล้ว แต่ไม่มีใครพูดถึงวิธีการปิดคำเตือนต่อไปนี้

เพิ่มสิ่งนี้เหนือลายเซ็นวิธีการเพื่อปิดสำหรับวิธีนั้นเท่านั้น:

    // ReSharper disable once ParameterOnlyUsedForPreconditionCheck.Local

เพิ่มสิ่งนี้เหนือการประกาศคลาสเพื่อปิดสำหรับทั้งไฟล์:

     // ReSharper disable ParameterOnlyUsedForPreconditionCheck.Local