Удаление ненужного подавления (IDE0079)

Статья
05/07/2024

Свойство	Значение
Идентификатор правила	IDE0079
Заголовок	Удалить ненужное подавление
Категория	Качество кода
Подкатегории	Ненужные правила кода (предпочтения подавления)
Применимые языки	C# и Visual Basic
Параметры	`dotnet_remove_unnecessary_suppression_exclusions`

Обзор

Это правило помечает ненужные подавления атрибутов pragma и SuppressMessageAttribute в источнике.

Подавление источника подавляет нарушения правил компилятора и анализатора в определенных местах, но не в других частях исходного кода. Как правило, вы используете их для подавления ложных срабатываний или менее важных нарушений, которые вы не собираетесь исправить. Однако подавление часто становится устаревшим. Это может произойти, если правило исправлено, чтобы предотвратить ложные срабатывания или рефакторинг кода, и при этом отрисовка избыточности подавления. Это правило помогает определить избыточные подавления, которые можно удалить.

Примечание.

Даже если в сборке включены правила стиля кода, это правило не включено. Он отображается только в редакторе Visual Studio.

Пример

using System.Diagnostics.CodeAnalysis;

class C1
{
    // Necessary pragma suppression
#pragma warning disable IDE0051 // IDE0051: Remove unused member
    private int UnusedMethod() => 0;
#pragma warning restore IDE0051

    // IDE0079: Unnecessary pragma suppression
#pragma warning disable IDE0051 // IDE0051: Remove unused member
    private int UsedMethod() => 0;
#pragma warning restore IDE0051

    public int PublicMethod() => UsedMethod();
}

class C2
{
    // Necessary SuppressMessage attribute suppression
    [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>")]
    private int _unusedField;

    // IDE0079: Unnecessary SuppressMessage attribute suppression
    [SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>")]
    private int _usedField;

    public int PublicMethod2() => _usedField;
}

Параметры

Параметры указывают поведение, которое требуется применить правило. Сведения о настройке параметров см . в разделе "Формат параметров".

dotnet_remove_unnecessary_suppression_exclusions

Свойство	Значение	Описание
Имя параметра	dotnet_remove_unnecessary_suppression_exclusions
Значения параметра	`,`разделенный список идентификаторов правил или категорий (с префиксом )`category:`	Исключает подавление перечисленных правил.
	`all`	Отключает правило (все идентификаторы правил исключены)
	`none`	Включает правило для всех правил (без исключений)
Значение параметра по умолчанию	`none`

using System.Diagnostics.CodeAnalysis;

class C1
{
    // 'dotnet_remove_unnecessary_suppression_exclusions = IDE0051'

    // Unnecessary pragma suppression, but not flagged by IDE0079
#pragma warning disable IDE0051 // IDE0051: Remove unused member
    private int UsedMethod() => 0;
#pragma warning restore IDE0051

    public int PublicMethod() => UsedMethod();
}

Отключение предупреждений

Если вы хотите отключить только одно нарушение, добавьте директивы препроцессора в исходный файл, чтобы отключить и повторно включить правило.

#pragma warning disable IDE0079
// The code that's violating the rule is on this line.
#pragma warning restore IDE0079

Чтобы отключить правило для файла, папки или проекта, задайте его серьезность none в файле конфигурации.

[*.{cs,vb}]
dotnet_diagnostic.IDE0079.severity = none

Чтобы отключить эту всю категорию правил, задайте уровень серьезности для категории none в файле конфигурации.

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-CodeQuality.severity = none

Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.

Поделиться через