Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
MSTEST0031:
| Property | Value |
|---|---|
| Rule ID | MSTEST0031 |
| Title | System.ComponentModel.DescriptionAttribute has no effect on test methods. |
| Category | Usage |
| Fix is breaking or non-breaking | Non-breaking |
| Enabled by default | Yes |
| Default severity | Warning starting with 4.0.0, Info before |
| Introduced in version | 3.5.0 |
| Is there a code fix | No |
Cause
'System.ComponentModel.DescriptionAttribute' has no effect in the context of tests.
Rule description
'System.ComponentModel.DescriptionAttribute' has no effect in the context of tests, so likely user wanted to use 'Microsoft.VisualStudio.TestTools.UnitTesting.DescriptionAttribute' instead.
How to fix violations
Remove or replace System.ComponentModel.DescriptionAttribute by Microsoft.VisualStudio.TestTools.UnitTesting.DescriptionAttribute instead.
When to suppress warnings
We don't recommend to suppress the diagnostic as the System.ComponentModel.DescriptionAttribute has no effect in the context of tests.
Suppress a warning
If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.
#pragma warning disable MSTEST0031
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0031
To disable the rule for a file, folder, or project, set its severity to none in the configuration file.
[*.{cs,vb}]
dotnet_diagnostic.MSTEST0031.severity = none
For more information, see How to suppress code analysis warnings.
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
