使用Go语言创建模块，并使用GoDoc生成文档

1 年 ago
新, 韵
1 minute

首先

在对Go语言和开发环境准备方面，我学习了关于Go语言以及如何准备开发环境的方法。

我已经总结了有关使用Go语言创建模块并使用GoDoc创建文档的备忘录。

GoDoc是什么

GoDoc是一个网站，通过在源代码中按照规则写评论，将公共函数、类型和变量的描述和实现示例作为文档进行托管。此外，您还可以在命令行上浏览文档。

有参考一本Go语言学习书

    • 基礎からわかる Go言語

 

    • スターティングGo言語

 

    • Go言語によるWebアプリケーション開発

 

    Goプログラミング実践入門　標準ライブラリでゼロからWebアプリを作る

请参考下列网站。

https://godoc-cn.org/golang.org/x/tools/cmd/godoc
https://blog.golang.cn/examples

事前准备

阅读关于Go语言和开发环境的相关内容后，我将准备好Go语言的开发环境。

请使用go get命令安装GoDoc的软件包。

$ go get golang.org/x/tools/cmd/godoc

考试实施

我用Package stringutil作为样例创建了实际的文档。

示例代码
https://github.com/golang/example
https://pkg.go.dev/github.com/golang/example/stringutil/

package stringutil_test

import (
    "fmt"

    "github.com/golang/example/stringutil"
)

func ExampleReverse() {
    fmt.Println(stringutil.Reverse("hello"))
    // Output: olleh
}

在 example_test.go 文件中，我们可以使用函数注释和 ExampleReverse 来编写使用示例，并进行测试执行。

$ go test -v
=== RUN TestReverse
--- PASS: TestReverse (0.00s)
=== RUN: ExampleReverse
--- PASS: ExampleReverse (0.00s)
PASS
ok      github.com/golang/example/stringutil    0.009s

将文档以网页形式展示。

$ godoc -http =：6060
reverse.png