Peringatan Penyusun Kustom

Saat menggunakan ObsoleteAtribute di .Net, ini memberi Anda peringatan kompiler yang memberi tahu Anda bahwa objek / metode / properti sudah usang dan ada hal lain yang harus digunakan. Saat ini saya mengerjakan proyek yang membutuhkan banyak refactoring kode mantan karyawan. Saya ingin menulis atribut khusus yang dapat saya gunakan untuk menandai metode atau properti yang akan menghasilkan peringatan compiler yang memberikan pesan yang saya tulis. Sesuatu seperti ini

[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

Saya ingin ini menghasilkan peringatan kompiler yang mengatakan, "Kode ini sux dan harus dilihat". Saya tahu cara membuat atribut khusus, pertanyaannya adalah bagaimana cara membuatnya menghasilkan peringatan kompiler di studio visual.

Memperbarui

Ini sekarang dimungkinkan dengan Roslyn (Visual Studio 2015). Anda dapat membangun sebuah analyzer kode untuk memeriksa atribut khusus

Saya tidak percaya itu mungkin. ObsoleteAttribute diperlakukan secara khusus oleh kompilator dan didefinisikan dalam standar C #. Mengapa ObsoleteAttribute tidak dapat diterima? Bagi saya, sepertinya inilah situasi yang dirancang untuk itu, dan mencapai tepat apa yang Anda butuhkan!

Perhatikan juga bahwa Visual Studio mengambil peringatan yang dihasilkan oleh ObsoleteAttribute dengan cepat juga, yang sangat berguna.

Bukan bermaksud tidak membantu, hanya bertanya-tanya mengapa Anda tidak tertarik untuk menggunakannya ...

Sayangnya ObsoleteAttribute disegel (mungkin sebagian karena perlakuan khusus) sehingga Anda tidak dapat membuat subkelas atribut Anda sendiri darinya.

Dari standar C #: -

Atribut Usang digunakan untuk menandai jenis dan anggota jenis yang tidak boleh lagi digunakan.

Jika program menggunakan tipe atau anggota yang didekorasi dengan atribut Usang, kompilator mengeluarkan peringatan atau kesalahan. Secara khusus, compiler mengeluarkan peringatan jika tidak ada parameter error yang diberikan, atau jika parameter error disediakan dan memiliki nilai false. Kompilator mengeluarkan kesalahan jika parameter kesalahan ditentukan dan memiliki nilai true.

Bukankah itu meringkas kebutuhan Anda? ... Anda tidak akan melakukan lebih baik dari yang saya kira.

Ini patut dicoba.

Anda tidak dapat memperpanjang Usang, karena sudah final, tetapi mungkin Anda dapat membuat atribut Anda sendiri, dan menandai kelas tersebut sebagai usang seperti ini:

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

Kemudian saat Anda menandai metode Anda dengan atribut "MustRefactor", peringatan kompilasi akan ditampilkan. Ini menghasilkan peringatan waktu kompilasi, tetapi pesan kesalahan terlihat lucu, Anda harus melihatnya sendiri dan memilih. Ini sangat dekat dengan apa yang ingin Anda capai.

PEMBARUAN: Dengan kode ini Ini menghasilkan peringatan (tidak terlalu bagus, tapi saya rasa tidak ada yang lebih baik).

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
{

}

Di beberapa kompiler, Anda dapat menggunakan #warning untuk mengeluarkan peringatan:

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

Di kompiler Microsoft, Anda biasanya dapat menggunakan pesan pragma:

#pragma message ( "text" )

Anda menyebutkan .Net, tetapi tidak menentukan apakah Anda memprogram dengan C / C ++ atau C #. Jika Anda memprogram dalam C #, Anda harus tahu bahwa C # mendukung format #warning .

Kami saat ini sedang melakukan banyak pemfaktoran ulang di mana kami tidak dapat langsung memperbaiki semuanya. Kami hanya menggunakan perintah preproc #warning di mana kami perlu kembali dan melihat kode. Ini muncul di keluaran kompiler. Saya tidak berpikir Anda dapat menerapkannya pada suatu metode, tetapi Anda dapat meletakkannya di dalam metode, dan itu masih mudah ditemukan.

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

Di VS 2008 (+ sp1) #warnings tidak ditampilkan dengan benar di Daftar Kesalahan setelah Solusi Bersihkan Soultion & Rebuild, tidak semuanya. Beberapa Peringatan hanya ditampilkan dalam Daftar Kesalahan setelah saya membuka file kelas tertentu. Jadi saya terpaksa menggunakan atribut khusus:

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

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

    public MappingToDo()
    {}
}

Jadi ketika saya menandai beberapa kode dengannya

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

Ini menghasilkan peringatan seperti ini:

Namespace.MappingToDo sudah usang: 'Mapping ToDo'.

Saya tidak bisa mengubah teks peringatan, 'Beberapa komentar' tidak ditampilkan Daftar Kesalahan. Tapi itu akan melompat ke tempat yang tepat dalam file. Jadi jika Anda perlu memvariasikan pesan peringatan tersebut, buatlah berbagai atribut.

Apa yang Anda coba lakukan adalah penyalahgunaan atribut. Sebaliknya gunakan Daftar Tugas Visual Studio. Anda dapat memasukkan komentar dalam kode Anda seperti ini:

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

Kemudian buka View / Task List dari menu. Daftar tugas memiliki dua kategori, tugas pengguna dan Komentar. Beralih ke Komentar dan Anda akan melihat semua // Todo: ada di sana. Mengklik dua kali pada TODO akan membuka komentar di kode Anda.

Al

Saya tidak berpikir Anda bisa. Sejauh yang saya tahu, dukungan untuk ObsoleteAttribute pada dasarnya di-hardcode ke dalam compiler C #; Anda tidak dapat melakukan hal serupa secara langsung.

Apa yang mungkin dapat Anda lakukan adalah menggunakan tugas MSBuild (atau acara pasca-pembuatan) yang menjalankan alat kustom terhadap rakitan yang baru saja dikompilasi. Alat kustom akan mencerminkan semua jenis / metode dalam perakitan dan menggunakan atribut kustom Anda, di mana ia dapat mencetak ke default System.Console atau kesalahan TextWriters.

Melihat sumber untuk ObsoleteAttribute , sepertinya tidak melakukan sesuatu yang khusus untuk menghasilkan peringatan kompiler, jadi saya akan cenderung menggunakan @ technophile dan mengatakan bahwa itu dikodekan dengan keras ke dalam kompiler. Apakah ada alasan mengapa Anda tidak ingin hanya menggunakan ObsoleteAttribute untuk menghasilkan pesan peringatan Anda?

Ada beberapa komentar yang menyarankan untuk memasukkan peringatan atau pragma. Karya usang dengan cara yang sangat berbeda! Menandai fungsi usang dari pustaka L, pesan usang muncul saat program memanggil fungsi tersebut meskipun program pemanggil tidak ada di pustaka L. Peringatan memunculkan pesan HANYA saat L dikompilasi.

Berikut adalah Implementasi Roslyn, sehingga Anda dapat membuat atribut Anda sendiri yang memberikan peringatan atau kesalahan dengan cepat.

Saya telah membuat atribut Type Called IdeMessageyang akan menjadi atribut yang menghasilkan peringatan:

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

    public IDEMessageAttribute(string message);
}

Untuk melakukan ini, Anda perlu menginstal Roslyn SDK terlebih dahulu dan memulai proyek VSIX baru dengan analyzer. Saya telah menghilangkan beberapa bagian yang kurang relevan seperti pesan, Anda dapat mengetahui cara melakukannya. Dalam penganalisis Anda, Anda melakukan ini

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

Tidak ada CodeFixProvider untuk ini, Anda dapat menghapusnya dari solusi.