自定义编译器警告

在.Net中使用ObsoleteAtribute时，它会向您提供编译器警告，告知您对象/方法/属性已过时，应使用其他方法。我目前正在从事一个需要大量重构前员工代码的项目。我想编写一个可用于标记方法或属性的自定义属性，该方法或属性将生成编译器警告，这些警告或警告将给出我编写的消息。像这样

[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，应予以注意”。我知道如何创建自定义属性，问题是如何使它在Visual Studio中生成编译器警告。

更新资料

Roslyn（Visual Studio 2015）现在可以做到这一点。你可以建立一个代码分析器来检查自定义属性

我不认为有可能。ObsoleteAttribute由编译器专门处理，并在C＃标准中定义。为什么地球上的ObsoleteAttribute不可接受？在我看来，这恰恰是它的设计目标，并且可以满足您的要求！

还要注意，Visual Studio也会即时获取由ObsoleteAttribute生成的警告，这非常有用。

并不是要无益，只是想知道为什么您不热衷于使用它...

不幸的是ObsoleteAttribute是密封的（可能部分是由于特殊处理），因此您不能从中继承自己的属性。

从C＃标准：

“过时”属性用于标记类型和不应再使用的类型成员。

如果程序使用用过时属性修饰的类型或成员，则编译器将发出警告或错误。具体来说，如果未提供错误参数，或者提供了错误参数且其值为false，则编译器会发出警告。如果指定了错误参数并且值为true，则编译器将发出错误。

那不是总结您的需求吗？...您做得不会比我想不到的要好。

这值得一试。

您不能扩展Obsolete，因为它是最终的，但也许您可以创建自己的属性，并将该类标记为过时，如下所示：

[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发出警告：

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

在Microsoft编译器中，通常可以使用消息编译指示：

#pragma message ( "text" )

您提到过.Net，但未指定是使用C / C ++还是C＃进行编程。如果您使用C＃编程，那么您应该知道C＃支持#warning格式。

我们目前处于大量重构的中间，无法立即修复所有问题。我们只使用#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已过时：'Mapping ToDo'。

我无法更改警告文字，“某些评论”未显示错误列表。但是它将跳到文件中的适当位置。因此，如果您需要更改此类警告消息，请创建各种属性。

您试图做的是滥用属性。而是使用Visual Studio任务列表。您可以在代码中输入如下注释：

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

然后从菜单中打开“查看/任务列表”。任务列表有两个类别，用户任务和注释。切换到评论，您将看到所有// Todo：在​​那里。双击TODO将跳转到代码中的注释。

铝

我认为你不能。据我所知，对ObsoleteAttribute的支持本质上是硬编码到C＃编译器中的。您不能直接做任何类似的事情。

您可能能够做的是使用MSBuild任务（或构建后事件），该任务对刚刚编译的程序集执行自定义工具。自定义工具将反映出程序集中的所有类型/方法并使用您的自定义属性，此时它可以打印到System.Console的默认或错误TextWriters。

查看ObsoleteAttribute的源代码，看起来它并没有做任何特别的事情来生成编译器警告，因此我倾向于使用@ technophile并说它是硬编码到编译器中的。您是否有理由不想仅使用ObsoleteAttribute生成警告消息？

有几条建议建议插入警告或杂注。过时的方式大相径庭！如果标记为过时的库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，您可以将其从解决方案中删除。