简单的 hello world 程序的 Go doc

Question

如何编写一个 go 程序，使其有一个简单的文档例子package HelloWorldimport "fmt"func HelloWorld() {    fmt.Println("hello world")}如果 exec 对此代码进行更改后go doc <needed command>它应该打印this is a hello world program 

Answer 1

在包声明之前的注释中输入文档，它们之间不留空行。

例如：

/*

This is a hello world program.

*/

package main

然后将包提供给go doc，如下所示：

go doc path/to/your/package

输出将是：

This is a hello world program.

Answer 2

我不是 100% 确定你要什么。但是你可以像这样描述一个 go 包，并且go doc会接受这个。

// this is some description for the package
package mypackage

然后您可以使用浏览器查看文档

godoc -http=:6060

使用 GoDoc 可以完成许多技巧，这些技巧在这个Github 存储库 - godoc-tricks或Go 团队的这篇博客文章中有所描述。