DiagnosticDescriptor Конструкторы

Определение

Пространство имен:

Microsoft.CodeAnalysis

Сборка:

Microsoft.CodeAnalysis.dll

Пакет:

Microsoft.CodeAnalysis.Common v4.12.0

Перегрузки

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Создайте DiagnosticDescriptor, предоставляющий описание объекта Diagnostic.
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Создайте DiagnosticDescriptor, предоставляющий описание объекта Diagnostic. ПРИМЕЧАНИЕ. Для локализуемых titleи description (или) messageFormatиспользуйте перегрузку DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])конструктора .

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])

Исходный код:

DiagnosticDescriptor.cs

Создайте DiagnosticDescriptor, предоставляющий описание объекта Diagnostic.

public DiagnosticDescriptor (string id, Microsoft.CodeAnalysis.LocalizableString title, Microsoft.CodeAnalysis.LocalizableString messageFormat, string category, Microsoft.CodeAnalysis.DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, Microsoft.CodeAnalysis.LocalizableString? description = default, string? helpLinkUri = default, params string[] customTags);

new Microsoft.CodeAnalysis.DiagnosticDescriptor : string * Microsoft.CodeAnalysis.LocalizableString * Microsoft.CodeAnalysis.LocalizableString * string * Microsoft.CodeAnalysis.DiagnosticSeverity * bool * Microsoft.CodeAnalysis.LocalizableString * string * string[] -> Microsoft.CodeAnalysis.DiagnosticDescriptor

Public Sub New (id As String, title As LocalizableString, messageFormat As LocalizableString, category As String, defaultSeverity As DiagnosticSeverity, isEnabledByDefault As Boolean, Optional description As LocalizableString = Nothing, Optional helpLinkUri As String = Nothing, ParamArray customTags As String())

Параметры

id

String

Уникальный идентификатор для диагностики. Например, диагностический идентификатор анализа кода "CA1001".

title

LocalizableString

Короткое локализуемое название, описывающее диагностику. Например, для CA1001: "Типы, владеющие одноразовыми полями, должны быть одноразовыми".

messageFormat

LocalizableString

Строка сообщения локализуемого формата, которую можно передать в качестве первого аргумента Format(String, Object[]) при создании диагностического сообщения с помощью этого дескриптора. Например, для CA1001: "Реализация IDisposable в "{0}", так как он создает члены следующих типов IDisposable: "{1}".

category

String

Категория диагностики (например, проектирование, именование и т. д.). Например, для CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Серьезность диагностики по умолчанию.

isEnabledByDefault

Boolean

Значение true, если диагностика включена по умолчанию.

description

LocalizableString

Необязательное более локализуемое описание диагностики.

helpLinkUri

String

Необязательная гиперссылка с более подробным описанием диагностики.

customTags

String[]

Необязательные настраиваемые теги для диагностики. Ознакомьтесь WellKnownDiagnosticTags со сведениями о некоторых хорошо известных тегах.

Комментарии

Пример дескриптора для правила CA1001:

internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(RuleId,
    new LocalizableResourceString(nameof(FxCopRulesResources.TypesThatOwnDisposableFieldsShouldBeDisposable), FxCopRulesResources.ResourceManager, typeof(FxCopRulesResources)),
    new LocalizableResourceString(nameof(FxCopRulesResources.TypeOwnsDisposableFieldButIsNotDisposable), FxCopRulesResources.ResourceManager, typeof(FxCopRulesResources)),
    FxCopDiagnosticCategory.Design,
    DiagnosticSeverity.Warning,
    isEnabledByDefault: true,
    helpLinkUri: "http://msdn.microsoft.com/library/ms182172.aspx",
    customTags: DiagnosticCustomTags.Microsoft);

Выберите соответствующий идентификатор диагностики , чтобы он был уникальным.

DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])

Исходный код:

DiagnosticDescriptor.cs

Создайте DiagnosticDescriptor, предоставляющий описание объекта Diagnostic. ПРИМЕЧАНИЕ. Для локализуемых titleи description (или) messageFormatиспользуйте перегрузку DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])конструктора .

public DiagnosticDescriptor (string id, string title, string messageFormat, string category, Microsoft.CodeAnalysis.DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, string? description = default, string? helpLinkUri = default, params string[] customTags);

new Microsoft.CodeAnalysis.DiagnosticDescriptor : string * string * string * string * Microsoft.CodeAnalysis.DiagnosticSeverity * bool * string * string * string[] -> Microsoft.CodeAnalysis.DiagnosticDescriptor

Public Sub New (id As String, title As String, messageFormat As String, category As String, defaultSeverity As DiagnosticSeverity, isEnabledByDefault As Boolean, Optional description As String = Nothing, Optional helpLinkUri As String = Nothing, ParamArray customTags As String())

Параметры

id

String

Уникальный идентификатор для диагностики. Например, диагностический идентификатор анализа кода "CA1001".

title

String

Краткое название, описывающее диагностику. Например, для CA1001: "Типы, владеющие одноразовыми полями, должны быть одноразовыми".

messageFormat

String

Строка сообщения формата, которую можно передать в качестве первого аргумента Format(String, Object[]) при создании диагностического сообщения с помощью этого дескриптора. Например, для CA1001: "Реализация IDisposable в "{0}", так как он создает члены следующих типов IDisposable: "{1}".

category

String

Категория диагностики (например, проектирование, именование и т. д.). Например, для CA1001: "Microsoft.Design".

defaultSeverity

DiagnosticSeverity

Серьезность диагностики по умолчанию.

isEnabledByDefault

Boolean

Значение true, если диагностика включена по умолчанию.

description

String

Необязательное более подробное описание диагностики.

helpLinkUri

String

Необязательная гиперссылка с более подробным описанием диагностики.

customTags

String[]

Необязательные настраиваемые теги для диагностики. Ознакомьтесь WellKnownDiagnosticTags со сведениями о некоторых хорошо известных тегах.

Комментарии

Выберите соответствующий идентификатор диагностики , чтобы он был уникальным.