protocol

# code_metrics_protocol

> Protocol for code_metrics tool.

author:
  `Ebrahim Azarisooreh`
version:
  `0.2`
date:
  `2017/4/23`

compilation flags:
  `static`

(no dependencies on other entities)

## Public interface

### entity_score/2

> True if Score is a term that represents the metric score associated with Entity.

compilation flags:
  `static`
template:
  `entity_score(Entity,Score)`
mode – number of proofs:
  `entity_score(?term,?term) – zero_or_more`

### metric_label/1

> Metric label for pretty printing of metrics data.

compilation flags:
  `static`
template:
  `metric_label(Label)`
mode – number of proofs:
  `metric_label(-atom) – one`

## Protected interface

(none)

## Private predicates

(none)

## Operators

### (none)

## Remarks

Usage
  This protocol should be implemented by any metric added to the system.

Score
  Score can be any type of term necessary to explain the nature of the entity and its relationship to the metric in question.

## See also

- code_metrics_utilities