Godoc-Generate:实现优秀代码文档的第一步

223 阅读1分钟

godoc-generate

Go Report Card

概述

godoc-generate 是一个简单的命令行工具,对当前工作目录下所有导出的 types,functions,constsvars 以及所有子目录的递归生成默认的godoc注释。

godoc注释看起来像这样。

// %s missing godoc.

其中%s 是类型/func/const/var的名称。

注意:注释格式可以通过--format 标志来覆盖。

安装

从源代码安装

go install github.com/DimitarPetrov/godoc-generate@latest

示范

假设你有一个简单的Multiply 函数,没有godoc

func  Multiply ( a , b  int ) int {
	 return  a  *  b 
}

它被导出了,因此它是包的接口的一部分。理想的做法是在你的包中的所有导出的东西上添加godoc。

如果你运行godoc-genenrate ,代码将被重写成以下方式。

// Multiply missing godoc.
func Multiply(a, b int) int {
	return a * b
}

这样你就可以安全地添加一个执行godoc的linter,并逐步迁移所有遗留代码。

GitHub

github.com/DimitarPetr…