godoc工具使用

golang除了语言有一定的规范外，对于文档的生成也是非常不错的，只要按go的格式来写的程序，都可以很容易的生成文档。

godoc命令介绍：
http://golang.org/cmd/godoc/
godoc blog（英文：
http://blog.golang.org/2011/03/godoc-documenting-go-code.html

遵守几个规则：
　注释需要紧贴对应的包声明和函数之前，不能有空行。
　如果注释内要有空行，应该使用空白注释行。
　开发者可以直接使用//BUG(author):的方式记录该代码片段中的遗留问题。

实际操作例子：
最常用的：
　godoc –http=”:8080”
　这样就打开了跟golang.org一样的网站，如果不能访问golang.org的时候就可以这样访问，而且建议一般平时就这样访问速度更快。
　并且pkg里面会有所有安装过的包，如：原来 go get labix.org/v2/mgo 就会有mgo的包　或者go install 到$GOROOT/src/pkg中也是可以查看到的。

终端下使用：
　godoc fmt Println
　就是打印fmt.Println这个函数的使用方法，如果习惯在终端命令行下可以如此使用

查看外部的包:
godoc -http=”:8080” -path=”.”
因为godoc默认是去$GOROOT/src/pkg读取的，如果有project不在这个下面的，我们可以使用path
　这有几个注意的问题：
　　1.如果使用. pkg里面只会有这个包的文档，不会有原来go自带的。使用绝对路径才会都有。
2.path不能以/ 结尾不然会报错invalid -path argument: “/root/go/” has no final element
3.文档显示是以path最后一个目录为包名，如目录结构为 project/src/todolist 如果path指到project 这一层　包的显示是 project src todolist 三层 如果指向src　就是src todolist　两层　只是显示的问题不影响使用，不过看着比较的别扭，好像没有太好的办法
　　4.所有上面的这些参数如果观察仔细会发现有的是–两杠和-一杠，两种方法都是可以接受的。http://www.ohlinux.com/archives/813/　shell python golang 参数传递的对比。

---

转载自http://bbs.studygolang.com/thread-91-1-1.html