comments

Documentation

Overview

Package with metric which checks comment complexity

Index

• type Metric
  • func (m Metric) Finish() float64
  • func (m *Metric) ParseNode(n ast.Node)
• type Weights

Types

type Metric

type Metric struct {
	// Config with weights
	Config Weights
	// contains filtered or unexported fields
}

Intermidiate state of metric

func (Metric) Finish

func (m Metric) Finish() float64

Returns metric result

func (*Metric) ParseNode

func (m *Metric) ParseNode(n ast.Node)

Parses ast node and collects metric result

type Weights

type Weights struct {
	// Weight of each word in every comment
	Word float64 `xml:"word"`
}

Config for metric