简单的 hello world 程序的 Go doc

Question

如何编写一个具有简单文档的 go 程序

例子

package HelloWorld

import "fmt"

func HelloWorld() {
    fmt.Println("hello world")
}

更改此代码后 if exec

go doc <needed command>

它应该打印

this is a hello world program 

Answer 1

我不是 100% 确定您的要求。 但是你可以像这样描述一个 go 包，go doc 会接受这个。

// this is some description for the package
package mypackage

然后您可以使用

在浏览器中查看文档

godoc -http=:6060

使用 GoDoc 可以完成许多技巧，这些技巧在 Github Repository - godoc-tricks or this blog post by the Go team 中进行了描述。

Answer 2

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

例如：

/*
This is a hello world program.
*/
package main

然后将包提供给go doc，像这样：

go doc path/to/your/package

输出将是：

This is a hello world program.