CA1517:使用
| Property | 价值 |
|---|---|
| 规则 ID | CA1517 |
| Title | 使用ReadOnlySpan<T>或Span<T>,代替ReadOnlyMemory<T>或Memory<T> |
| 类别 | 可维护性 |
| 修复是中断修复还是非中断修复 | Non-breaking |
| 在 .NET 10 中默认启用 | No |
| 默认在 .NET 11 中启用 | 作为一种建议 |
| 适用的语言 | C# |
Cause
方法具有一个它不修改的 Span<T> 或 Memory<T> 参数。
规则说明
使用 ReadOnlySpan<T> 或 ReadOnlyMemory<T> 用于方法仅读取的数据。 只读类型使方法的意向清晰,并允许调用方传递无法修改的数据。
如何修复违规行为
将参数类型更改为其只读对应类型。 分析器不会报告无法安全地更改其参数类型的方法,例如虚拟或接口方法。
Examples
以下代码显示了 CA1517 的违规:
static int GetFirst(Span<int> values) => values[0];
将 Span<T> 更改为 ReadOnlySpan<T>:
static int GetFirst(ReadOnlySpan<int> values) => values[0];
对于 Memory<T> 参数,请改用 ReadOnlyMemory<T> 。
何时禁止显示警告
仅当方法必须公开可写参数时,才禁止显示警告,即使其当前实现不会修改数据。
禁止显示警告
若要取消单个违规,请将预处理器指令添加到源文件中以禁用该规则,然后重新启用它。
#pragma warning disable CA1517
// The code that's violating the rule is on this line.
#pragma warning restore CA1517
若要禁用文件、文件夹或项目的规则,请在none中将其严重性设置为。
[*.{cs,vb}]
dotnet_diagnostic.CA1517.severity = none
有关详细信息,请参阅 如何禁止显示代码分析警告。