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

診断の一意識別子。 たとえば、コード分析の診断 ID "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);

一意になるように適切な診断 ID を選択します。

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

診断の一意識別子。 たとえば、コード分析の診断 ID "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 。

注釈

一意になるように適切な診断 ID を選択します。