quality

package
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package quality 提供可重复执行的覆盖率与文档质量门禁。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckBaseline

func CheckBaseline(root string) error

CheckBaseline 校验参考版本清单的完整性及已锁定制品摘要。 @param root 仓库根目录 @return 版本或制品错误

func CheckDocumentation

func CheckDocumentation(root string) ([]string, error)

CheckDocumentation 校验所有命名函数的中文说明、参数与返回值注释。 @param root 仓库根目录 @return 违规清单 @return 文件解析错误

func RouteReport

func RouteReport(specification, implementation string, differences map[string]string) string

RouteReport 对照官方规范和实现生成以方法及规范化路径为主键的清单。 @param specification 已固定的上游规范 @param implementation 路由源代码 @param differences 已声明的兼容验收状态与差异 @return 可重复生成的中文端点表

Types

type Coverage

type Coverage struct {
	Covered int // 已覆盖语句
	Total   int // 全部语句
}

Coverage 是语句覆盖统计。

func CheckCoverage

func CheckCoverage(reader io.Reader, excluded []string, minimum float64) (Coverage, error)

CheckCoverage 读取 Go 覆盖率文件,按语句权重检查总量及每个包。 @param reader 覆盖率文件 @param excluded 明确排除的路径前缀 @param minimum 最低比例 @return 总覆盖统计 @return 格式或阈值错误

func (Coverage) Ratio

func (c Coverage) Ratio() float64

Ratio 返回覆盖率;没有可执行语句时视为完全覆盖。 @return 覆盖率

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL