英文:
Idiomatic way of documenting a Golang program, consisting of one main.go file
问题
我写了一个Go工具，它根据输入读取文件并生成输出。它由一个main.go文件组成。我应该在哪里记录工具的功能，以便使用godoc（或者只是符合惯例）？
// 我应该在这里解释吗？
package main
// 还是在这里？
func main() {
// 代码！
}
// 还是其他地方？
英文:
I wrote a Go tool which reads files and produces output based on the input. It consists of one main.go file. Where do I document what the tool does, in order to make use of godoc (or just be idiomatic)?
// Should I explain it here?
package main
// Or here?
func main() {
// code!
}
// Or somewhere else?
答案1
得分: 13
要为godoc或pkg.go.dev记录一个命令，可以将命令文档写在包注释中。
// Command foo does bar.
package main
func main() {
// code!
}
请参阅stringer.go中的注释和stringer文档以获取示例。
默认情况下，godoc和pkg.go.dev会隐藏名为"main"的包中的所有其他文档注释。
英文:
To document a command for godoc or pkg.go.dev, write the command documentation in the package comment.
// Command foo does bar.
package main
func main() {
// code!
}
See the comment in stringer.go and the stringer documentation for an example.
By default, godoc and pkg.go.dev hide all other doc comments in a package with the name "main".
通过集体智慧和协作来改善编程学习和解决问题的方式。致力于成为全球开发者共同参与的知识库，让每个人都能够通过互相帮助和分享经验来进步。
评论