NDepend.API Documentation
TryGetExplanation Method
NDepend.Issue Namespace > IIssue Interface : TryGetExplanation Method
The formatting of the returned explanation.
A debt formatter object to format debt estimation(s) if any.
The issue explanation formatted.
Try get an explanation string for this issue.
Syntax
bool TryGetExplanation( 
   StringFormattingKind stringFormattingKind,
   IDebtFormatter debtFormatter,
   out string explanation
)

Parameters

stringFormattingKind
The formatting of the returned explanation.
debtFormatter
A debt formatter object to format debt estimation(s) if any.
explanation
The issue explanation formatted.

Return Value

true if the issue explanation is available.
Remarks
An explanation string is returned only if IssueReferenceRecord.IssueReferenceRecord.Yes is used when obtaining the issues of a rule by calling the method NDepend.CodeQuery.ExtensionMethodsQuery.GetIssues(IRule,IQueryExecutionSuccessResult,IssueReferenceRecord).
Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

See Also

Reference

IIssue Interface
IIssue Members

Send Feedback