记录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或godoc.org的命令,请在包注释中编写命令文档.

// Command foo does bar.
package main

func main() {
   // code!
}

有关示例,请参阅stringer.go中的注释和stringer文档.

默认情况下,godoc和godoc.org将所有其他文档注释隐藏在名为"main"的包中.