godoc介绍
godoc为go语言提供文档生成的工具
godoc有两种使用的方法
命令行使用
godoc fmt Println // 输出fmt.Println的用法文档
godoc -src fmt Println //fmt.Println的实现
启动server
godoc -http=":6060"
搜索
godoc -q Reader
编写godoc文档
规则:
- 类型、变量、函数、常量编写注释的时候,直接在声明前编写注释,中间不留空行。
// Fprint formats using the default formats for its operands and writes to w.
// Spaces are added between operands when neither is a string.
// It returns the number of bytes written and any write error encountered.
func Fprint(w io.Writer, a ...interface{}) (n int, err error) {
- 包注释应该提供这个包的一般化文档。
// Package sort provides primitives for sorting slices and user-defined
// collections.
package sort
- 如果需要大量介绍性文档时,包注释需要放在一个单独的文件
doc.go
。 - bug记录
// BUG(r):The rule Title uses for word boundaries does not handle Unicode punctuation properly.
TODO
godoc -analysis使用