Code Diagnostics (CTP)

• Jan 26, 2022
• 2 minutes to read

Note

This feature is currently available as a community technology preview (CTP)

The code analysis feature helps you detect XAF-specific errors in your code as you type. If a code analyzer finds rule violations, they are reported in the code editor (as a squiggle under the invalid code) and in the Error List window.

Note

Code analysis works only with C# code.

Enable Code Analysis

To turn on code analysis, add the DevExpress.ExpressApp.CodeAnalysis NuGet package to all projects in your XAF solution. The Solution Wizard adds this package to newly created .NET 5 projects.

Code analysis requires Visual Studio 2019 for .NET Framework projects.

Disable Code Analysis

To turn off code analysis, remove the DevExpress.ExpressApp.CodeAnalysis NuGet package from your project.

You can suppress the warning messages as described in the following Microsoft article: How to suppress code analysis warnings.

C#

// ...
namespace MySolution.Module.Controllers {
#pragma warning disable XAF0005 // XAF Controller classes should be public
    class MyViewController : ViewController {
#pragma warning restore XAF0005 // XAF Controller classes should be public
        // ...
    }
}

Supported Diagnostics

• XAF0001: Implement XPO business class constructors correctly
• XAF0002: XPO business class properties should not be overridden
• XAF0003: XPO business classes should be public
• XAF0004: Implement XAF controller constructors correctly
• XAF0005: XAF controller classes should be public
• XAF0009: Properties decorated with the RuleRequiredFieldAttribute should be of nullable or reference type
• XAF0010: Set the DelayedAttribute.UpdateModifiedOnly property to True
• XAF0011: Implement the delayed property correctly