comments

Documentation

Overview

Package comments provides functions to know information about comments in a Golang project

Index

• type CommentsMetrics
  • func ResolveCommentsMetrics(prj *project.ProjectInfo) (*CommentsMetrics, error)

Types

type CommentsMetrics

type CommentsMetrics struct {
	TotalLines             int     `json:"total_lines"`               // total of comment lines
	CommentsRatio          float64 `json:"ratio"`                     // ratio of comment lines (comments_loc / project_loc)
	FilesWithComments      int     `json:"files_with_comments"`       // number of files with comments
	FilesWithCommentsRatio float64 `json:"files_with_comments_ratio"` // ratio of files with comments
}

CommentsMetrics represents the comments stats in ao Golang project

func ResolveCommentsMetrics

func ResolveCommentsMetrics(prj *project.ProjectInfo) (*CommentsMetrics, error)

ResolveCommentsMetrics retrieves metrics about comments in the provided Golang project.

An error is returned when it's not possible to get the packages information