记录一个golang程序的惯用方法，该程序由一个main.go文件组成

Question

我编写了一个GO工具，该工具读取文件并根据输入产生输出。它由一个main.go文件组成。我在哪里可以记录该工具的作用，以便使用Godoc(或只是惯用(？

// Should I explain it here?
package main
// Or here?
func main() {
    // code!
}
// Or somewhere else?

Answer 1

要记录godoc或pkg.go.dev的命令，在软件包注释中写下命令文档。

// Command foo does bar.
package main
func main() {
   // code!
}

请参见stringer.go中的评论和弦乐文档以示例。

默认情况下，godoc和pkg.go.dev隐藏所有其他文档在包装中，名称为" Main"。