NDepend.API Documentation
IDebtFormatter Interface Members
Properties  Methods 

NDepend.TechnicalDebt Namespace : IDebtFormatter Interface

The following tables list the members exposed by IDebtFormatter.

Public Properties
 NameDescription
 PropertyGets a cloned copy of the DebtSettings object from which formatting is done by this IDebtFormatter.  
Top
Public Methods
 NameDescription
 MethodGet the AnnualInterest threshold corresponding to the severity  
 MethodReturns the estimated cost, to reach a better rating, based on the fact that codeElement has actually a total debt estimated to debt.  
 MethodReturns the estimated effort to reach ratingToReach, based on the fact that codeElement has actually a total debt estimated to debt.  
 MethodEvaluate the total time to develop codeElement based on codeElement.NDepend.CodeModel.ExtensionMethodsHelpers.GetNbLinesOfCode_GuaranteedIfPDBFound, by applying a linear coefficent inferred from this.DebtSettings.DebtSettings.EstimatedNumberOfManDayToDevelop1000LogicalLinesOfCode and this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay.  
 MethodEstimate the debt rating of codeElement in the range DebtRating.A (very good) to DebtRating.E (very bad).  
 MethodEstimate the ratio of technical debt, measured through debt, for codeElement. This ratio is expressed in percentage, of estimated debt, compared to the estimated time it would take to rewrite codeElement from scratch.  
 MethodGets a string that represents the ratio of technical debt, measured through debt, for codeElement. This ratio is expressed in percentage of estimated debt to fix the debt, compared to the estimated duration it would take to rewrite codeElement from scratch.  
 MethodOverloaded. Gets a double number of man-days that represents duration. The number of man-days is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay.  
 MethodGets a string that represents duration as a number of man-days. The number of man-days is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay.  
 MethodGets a detailed string that represents duration as a number of man-days. The number of man-days is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay.  
 MethodOverloaded. Gets a double number of man-months that represents duration. The number of man-months is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay and this.DebtSettings.DebtSettings.NumberOfWorkDayPerYear.  
 MethodGets a string that represents duration as a number of man-months. The number of man-months is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay and this.DebtSettings.DebtSettings.NumberOfWorkDayPerYear.  
 MethodGets a detailed string that represents duration as a number of man-months. The number of man-months is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay and this.DebtSettings.DebtSettings.NumberOfWorkDayPerYear.  
 MethodOverloaded. Gets a double number of man-years that represents duration. The number of man-years is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay and this.DebtSettings.DebtSettings.NumberOfWorkDayPerYear.  
 MethodGets a string that represents duration as a number of man-years. The number of man-years is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay and this.DebtSettings.DebtSettings.NumberOfWorkDayPerYear.  
 MethodGets a detailed string that represents duration as a number of man-years. The number of man-years is computed from this.DebtSettings.DebtSettings.NumberOfWorkHourPerDay and this.DebtSettings.DebtSettings.NumberOfWorkDayPerYear.  
 MethodOverloaded. Estimate an amount of money from a duration.  
 MethodGets a string shortened with 'K' for thousands and 'M' for millions, that represents an amount of money estimated from a duration.  
 MethodGets a string that represents an amount of money estimated from a duration.  
 MethodGets a Severity from annualInterest an issue, expressed in man-time per year.  
 MethodOverloaded. Format the technical duration to a string, according to the DebtSettings.DebtSettings.DebtStringFormat.  
Top
See Also

Reference

IDebtFormatter Interface
NDepend.TechnicalDebt Namespace