ToDebtRatioString Method

Gets a string that represents the ratio of technical debt, measured through , for . This ratio is expressed in percentage of estimated to fix the debt, compared to the estimated duration it would take to rewrite from scratch.

Syntax

string ToDebtRatioString( 
   Debt debt,
   ICodeElement codeElement
)

Parameters

debt: The estimated debt to fix all issues on codeElement
codeElement: The code element on which we infer the percentage of debt

Return Value

The percentage of technical debt or the string "N/A" if the metric NbLinesOfCode is not available for .

Remarks

This method is obtaining the number of lines of code for from the method, NDepend.CodeModel.ExtensionMethodsHelpers.NDepend.CodeModel.ExtensionMethodsHelpers.GetNbLinesOfCode_GuaranteedIfPDBFound.
This method returns null, if and only if, NDepend.CodeModel.ExtensionMethodsHelpers.GetNbLinesOfCode_GuaranteedIfPDBFound returns null for .
To estimate the time it would take to rewrite from scratch, both DebtSettings values are used:
- DebtSettings.EstimatedNumberOfManDayToDevelop1000LogicalLinesOfCode
- DebtSettings.NumberOfWorkHourPerDay
If is overflow this method returns the string "overflow".

Requirements

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

Reference

IDebtFormatter Interface
IDebtFormatter Members