编译时检测意外地将C#属性分配给自身

概述Visual Studio C#编译器 warns about accidentally assigning a variable to itself,但此警告不适用于C#属性,仅适用于变量.如 this other question所述. 但是,如果我为自己分配一个属性,我真的会喜欢类似的东西,可以在编译时警告我. 我目前正在使用Visual Studio 2013,但如果解决方案至少在Visu Visual Studio C#编译器 warns about accidentally assigning a variable to itself,但此警告不适用于C#属性,仅适用于变量.如 this other question所述.

但是,如果我为自己分配一个属性,我真的会喜欢类似的东西,可以在编译时警告我.

我目前正在使用Visual Studio 2013,但如果解决方案至少在Visual Studio 2015中有效,我很好.此外,我不使用像ReSharper或Coderush这样的第三方商业插件,所以我更倾向于不使用的解决方案涉及购买东西,但我愿意接受建议.

你知道我怎么能做到这一点？

背景：

我已经习惯了使用Readonly public “inspection” properties存储接收到的依赖项的constructor dependency injection模式.

例如,假设一个依赖于ILogger实现的类Foo.记录器实例在构造函数中提供给类,构造函数检查空值并将依赖项存储在名为Logger的实例属性中：

public class Foo{    public ILogger Logger { get; private set; }    public Foo(ILogger logger)    {        if(logger == null) throw new ArgumentNullException("logger");        this.Logger = logger;    }}

但是,我经常输入错误,将属性分配给自己而不是传递给构造函数的参数.

public class Foo{    public ILogger Logger { get; private set; }    public Foo(ILogger logger)    {        if(logger == null) throw new ArgumentNullException("logger");        this.Logger = Logger; // <-- This is wrong. Property assigned to itself.    }}

当然,我总是在测试和调试时总是抓住这些错误,但它已经咬过我几次了,我不想再浪费时间在这样一个愚蠢的错误中.

有什么建议？

解决方法 这是VS2015实时代码分析器的完美情况.您可以编写一个基本分析器来检查是否将属性分配给自身并创建错误.

这是一个非常好的教程,我很久以前就帮助你开始学习如何写一个,他们不是很难做到：“C# and Visual Basic – Use Roslyn to Write a Live Code Analyzer for Your API”

更新：我有一些空闲时间所以我写了一个分析器,它做到了.

[Diagnosticanalyzer(Languagenames.CSharp)]public class SelfAssignmentAnalyzer : Diagnosticanalyzer{    public const string DiagnosticID = "SelfAssignment";    private static Readonly LocalizableString Title = "Do not do self assignment";    private static Readonly LocalizableString messageformat = "The variable '{0}' is assigned to itself";    private static Readonly LocalizableString Description = "A variable assignment to itself is likely an indication of a larger error.";    private const string category = "Correctness";    private static DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticID,Title,messageformat,category,DiagnosticSeverity.Warning,isEnabledByDefault: true,description: Description);    public overrIDe ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(Rule); } }    public overrIDe voID Initialize(AnalysisContext context)    {        context.RegisterSyntaxNodeAction(AnalyZenode,SyntaxKind.SimpleAssignmentExpression);    }    private voID AnalyZenode(SyntaxNodeAnalysisContext context)    {        var assignmentExpr = (AssignmentExpressionSyntax)context.Node;        var right = context.SemanticModel.GetSymbolinfo(assignmentExpr.Right);        var left = context.SemanticModel.GetSymbolinfo(assignmentExpr.left);        if (!right.Equals(left))            return;        var diagnostic = Diagnostic.Create(Rule,assignmentExpr.GetLocation(),assignmentExpr.left.ToString());        context.ReportDiagnostic(diagnostic);    }}

您可以进行优化,可以在不调用GetSymbolinfo的情况下排除情况(例如,检查左侧和右侧的文本以查看它们是否匹配)但我将其作为练习留给您.

编辑：

Visual Studio 2015中的分析器：

总结

以上是内存溢出为你收集整理的编译时检测意外地将C#属性分配给自身全部内容，希望文章能够帮你解决编译时检测意外地将C#属性分配给自身所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。