คำเตือนคอมไพเลอร์ที่กำหนดเอง

เมื่อใช้ ObsoleteAtribute ใน. Net จะให้คำเตือนคอมไพเลอร์ที่บอกคุณว่าอ็อบเจ็กต์ / วิธีการ / คุณสมบัติล้าสมัยและควรใช้อย่างอื่น ฉันกำลังทำโปรเจ็กต์ที่ต้องรีแฟคโค้ดอดีตพนักงานเป็นจำนวนมาก ฉันต้องการเขียนแอตทริบิวต์ที่กำหนดเองที่ฉันสามารถใช้เพื่อทำเครื่องหมายวิธีการหรือคุณสมบัติที่จะสร้างคำเตือนของคอมไพเลอร์ที่ให้ข้อความที่ฉันเขียน อะไรทำนองนี้

[MyAttribute("This code sux and should be looked at")]
public void DoEverything()
{
}

<MyAttribute("This code sux and should be looked at")>
Public Sub DoEverything()
End Sub

ฉันต้องการให้สิ่งนี้สร้างคำเตือนคอมไพเลอร์ที่ระบุว่า "รหัสนี้ sux และควรได้รับการตรวจสอบ" ฉันรู้วิธีสร้างแอตทริบิวต์ที่กำหนดเองคำถามคือฉันจะทำให้มันสร้างคำเตือนคอมไพเลอร์ในสตูดิโอภาพได้อย่างไร

ปรับปรุง

ตอนนี้สามารถทำได้ด้วย Roslyn (Visual Studio 2015) คุณสามารถสร้างตัววิเคราะห์โค้ดเพื่อตรวจสอบแอตทริบิวต์ที่กำหนดเอง

ฉันไม่เชื่อว่ามันจะเป็นไปได้ ObsoleteAttribute ได้รับการปฏิบัติเป็นพิเศษโดยคอมไพเลอร์และกำหนดไว้ในมาตรฐาน C # ทำไม ObsoleteAttribute ถึงไม่ยอมรับบนโลก สำหรับฉันแล้วดูเหมือนว่านี่เป็นสถานการณ์ที่ถูกออกแบบมาสำหรับและบรรลุสิ่งที่คุณต้องการอย่างแม่นยำ!

โปรดทราบว่า Visual Studio รับคำเตือนที่สร้างโดย ObsoleteAttribute ทันทีซึ่งมีประโยชน์มาก

อย่าคิดว่าจะไม่มีประโยชน์แค่สงสัยว่าทำไมคุณถึงไม่กระตือรือร้นที่จะใช้มัน ...

น่าเสียดายที่ ObsoleteAttribute ถูกปิดผนึก (ส่วนหนึ่งอาจเกิดจากการดูแลพิเศษ) ดังนั้นคุณจึงไม่สามารถ subclass แอตทริบิวต์ของคุณเองจากมันได้

จากมาตรฐาน C #: -

แอตทริบิวต์ล้าสมัยใช้เพื่อทำเครื่องหมายประเภทและสมาชิกของประเภทที่ไม่ควรใช้อีกต่อไป

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

นั่นสรุปความต้องการของคุณไม่ใช่เหรอ ... คุณจะไม่ทำได้ดีไปกว่าที่ฉันไม่คิด

นี่น่าลอง

คุณไม่สามารถขยายความล้าสมัยได้เนื่องจากเป็นขั้นสุดท้าย แต่บางทีคุณอาจสร้างแอตทริบิวต์ของคุณเองและทำเครื่องหมายว่าคลาสนั้นล้าสมัยเช่นนี้:

[Obsolete("Should be refactored")]
public class MustRefactor: System.Attribute{}

จากนั้นเมื่อคุณทำเครื่องหมายวิธีการของคุณด้วยแอตทริบิวต์ "MustRefactor" คำเตือนการคอมไพล์จะแสดงขึ้น สร้างคำเตือนเวลาคอมไพล์ แต่ข้อความแสดงข้อผิดพลาดดูตลกคุณควรดูด้วยตัวคุณเองและเลือก สิ่งนี้ใกล้เคียงกับสิ่งที่คุณต้องการบรรลุมาก

อัปเดต: ด้วยรหัสนี้จะสร้างคำเตือน (ไม่ค่อยดีนัก แต่ฉันไม่คิดว่าจะมีอะไรดีกว่านี้)

public class User
{
    private String userName;

    [TooManyArgs] // Will show warning: Try removing some arguments
    public User(String userName)
    {
        this.userName = userName;   
    }

    public String UserName
    {
        get { return userName; }
    }
    [MustRefactor] // will show warning: Refactor is needed Here
    public override string ToString()
    {
        return "User: " + userName;
    }
}
[Obsolete("Refactor is needed Here")]
public class MustRefactor : System.Attribute
{

}
[Obsolete("Try removing some arguments")]
public class TooManyArgs : System.Attribute
{

}

ในคอมไพเลอร์บางตัวคุณสามารถใช้ # คำเตือนเพื่อออกคำเตือน:

#warning "Do not use ABC, which is deprecated. Use XYZ instead."

ในคอมไพเลอร์ของ Microsoft โดยทั่วไปคุณสามารถใช้ข้อความ pragma:

#pragma message ( "text" )

คุณพูดถึง. Net แต่ไม่ได้ระบุว่าคุณกำลังเขียนโปรแกรมด้วย C / C ++ หรือ C # หากคุณกำลังเขียนโปรแกรมใน C # กว่าที่คุณควรรู้ว่าC # สนับสนุนรูปแบบ

ขณะนี้เรากำลังอยู่ระหว่างการปรับโครงสร้างใหม่จำนวนมากซึ่งเราไม่สามารถแก้ไขทุกอย่างได้ในทันที เราเพียงใช้คำสั่ง #warning preproc ซึ่งเราต้องย้อนกลับไปดูโค้ด จะปรากฏในเอาต์พุตของคอมไพเลอร์ ฉันไม่คิดว่าคุณจะใส่มันลงในวิธีการ แต่คุณสามารถใส่มันเข้าไปในวิธีการนั้นได้และมันก็ยังหาได้ง่าย

public void DoEverything() {
   #warning "This code sucks"
}

ใน VS 2008 (+ sp1) # คำเตือนไม่แสดงอย่างถูกต้องในรายการข้อผิดพลาดหลังจาก Clean Soultion & Rebuild Solution ไม่ใช่ทั้งหมด คำเตือนบางอย่างจะแสดงในรายการข้อผิดพลาดหลังจากที่ฉันเปิดไฟล์คลาสเฉพาะเท่านั้น ดังนั้นฉันจึงถูกบังคับให้ใช้แอตทริบิวต์ที่กำหนดเอง:

[Obsolete("Mapping ToDo")]
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
public class MappingToDo : System.Attribute
{
    public string Comment = "";

    public MappingToDo(string comment)
    {
        Comment = comment;
    }

    public MappingToDo()
    {}
}

ดังนั้นเมื่อฉันตั้งค่าสถานะบางรหัสด้วย

[MappingToDo("Some comment")]
public class MembershipHour : Entity
{
    // .....
}

มันสร้างคำเตือนเช่นนี้:

Namespace.MappingToDo ล้าสมัย: 'การแมป ToDo'

ฉันไม่สามารถเปลี่ยนข้อความของคำเตือนได้, 'ความคิดเห็นบางส่วน' ไม่แสดงในรายการข้อผิดพลาด แต่จะข้ามไปยังตำแหน่งที่เหมาะสมในไฟล์ ดังนั้นหากคุณต้องการเปลี่ยนแปลงข้อความเตือนดังกล่าวให้สร้างแอตทริบิวต์ต่างๆ

สิ่งที่คุณพยายามทำคือการใช้คุณลักษณะในทางที่ผิด ใช้รายการงาน Visual Studio แทน คุณสามารถป้อนความคิดเห็นในรหัสของคุณดังนี้:

//TODO:  This code sux and should be looked at
public class SuckyClass(){
  //TODO:  Do something really sucky here!
}

จากนั้นเปิด View / Task List จากเมนู รายการงานมีสองประเภทงานของผู้ใช้และความคิดเห็น เปลี่ยนเป็นความคิดเห็นแล้วคุณจะเห็น // สิ่งที่ต้องทำทั้งหมดของคุณที่นั่น ดับเบิลคลิกที่สิ่งที่ต้องทำจะข้ามไปที่ความคิดเห็นในโค้ดของคุณ

อัล

ฉันไม่คิดว่าคุณจะทำได้ เท่าที่ฉันรู้ว่าการสนับสนุน ObsoleteAttribute นั้นเข้ารหัสในคอมไพเลอร์ C # เป็นหลัก คุณไม่สามารถทำอะไรที่คล้ายกันได้โดยตรง

สิ่งที่คุณอาจทำได้คือใช้งาน MSBuild (หรือเหตุการณ์หลังการสร้าง) ที่เรียกใช้เครื่องมือแบบกำหนดเองกับแอสเซมบลีที่คอมไพล์ เครื่องมือที่กำหนดเองจะแสดงถึงประเภท / วิธีการทั้งหมดในแอสเซมบลีและใช้แอตทริบิวต์ที่กำหนดเองของคุณซึ่งจะสามารถพิมพ์ไปยัง System.Console เริ่มต้นหรือ TextWriters ข้อผิดพลาด

เมื่อมองไปที่ซอร์สของObsoleteAttributeดูเหมือนว่าจะไม่ได้ทำอะไรเป็นพิเศษในการสร้างคำเตือนของคอมไพเลอร์ดังนั้นฉันมักจะใช้ @ technophileและบอกว่าฮาร์ดโค้ดในคอมไพเลอร์ มีเหตุผลที่คุณไม่ต้องการเพียงแค่ใช้ObsoleteAttributeเพื่อสร้างข้อความเตือนของคุณหรือไม่?

มีหลายความคิดเห็นที่แนะนำให้ใส่คำเตือนหรือ pragma ล้าสมัยทำงานในลักษณะที่แตกต่างกันมาก! การทำเครื่องหมายฟังก์ชันของไลบรารี L ล้าสมัยข้อความล้าสมัยจะเพิ่มขึ้นเมื่อโปรแกรมเรียกใช้ฟังก์ชันแม้ว่าโปรแกรมผู้โทรจะไม่ได้อยู่ในไลบรารี L คำเตือนจะเพิ่มข้อความเฉพาะเมื่อคอมไพล์ L

นี่คือการนำ Roslyn ไปใช้เพื่อให้คุณสามารถสร้างแอตทริบิวต์ของคุณเองที่ให้คำเตือนหรือข้อผิดพลาดได้ทันที

ฉันได้สร้างแอตทริบิวต์ Type called IdeMessageซึ่งจะเป็นแอตทริบิวต์ที่สร้างคำเตือน:

[AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public class IDEMessageAttribute : Attribute
{
    public string Message;

    public IDEMessageAttribute(string message);
}

ในการดำเนินการนี้คุณต้องติดตั้ง Roslyn SDK ก่อนและเริ่มโครงการ VSIX ใหม่ด้วยตัววิเคราะห์ ฉันได้ละเว้นบางส่วนที่เกี่ยวข้องน้อยกว่าเช่นข้อความคุณสามารถหาวิธีทำได้ ในเครื่องวิเคราะห์ของคุณคุณทำสิ่งนี้

public override void Initialize(AnalysisContext context)
{
    context.RegisterSyntaxNodeAction(AnalyzerInvocation, SyntaxKind.InvocationExpression);
}

private static void AnalyzerInvocation(SyntaxNodeAnalysisContext context)
{
    var invocation = (InvocationExpressionSyntax)context.Node;

    var methodDeclaration = (context.SemanticModel.GetSymbolInfo(invocation, context.CancellationToken).Symbol as IMethodSymbol);

    //There are several reason why this may be null e.g invoking a delegate
    if (null == methodDeclaration)
    {
        return;
    }

    var methodAttributes = methodDeclaration.GetAttributes();
    var attributeData = methodAttributes.FirstOrDefault(attr => IsIDEMessageAttribute(context.SemanticModel, attr, typeof(IDEMessageAttribute)));
    if(null == attributeData)
    {
        return;
    }

    var message = GetMessage(attributeData); 
    var diagnostic = Diagnostic.Create(Rule, invocation.GetLocation(), methodDeclaration.Name, message);
    context.ReportDiagnostic(diagnostic);
}

static bool IsIDEMessageAttribute(SemanticModel semanticModel, AttributeData attribute, Type desiredAttributeType)
{
    var desiredTypeNamedSymbol = semanticModel.Compilation.GetTypeByMetadataName(desiredAttributeType.FullName);

    var result = attribute.AttributeClass.Equals(desiredTypeNamedSymbol);
    return result;
}

static string GetMessage(AttributeData attribute)
{
    if (attribute.ConstructorArguments.Length < 1)
    {
        return "This method is obsolete";
    }

    return (attribute.ConstructorArguments[0].Value as string);
}

ไม่มี CodeFixProvider สำหรับสิ่งนี้คุณสามารถลบออกจากโซลูชันได้