diff --git a/README.md b/README.md index 245bd6f..5ec5f6d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ 该翻译版本已获得原作者(Ivo Balbaert)本人授权,并表示支持开源事业的发展! ##翻译进度 -3.5 [格式化代码](eBook/03.5.md) +3.6 [生成代码文档](eBook/03.6.md) ##支持本书 如果你喜欢本书《Go入门指南》,你可以参与到本书的翻译或纠正工作中来,具体请联系译者,一同完善本书并帮助壮大 Go 语言在国内的学习群体,给大家提供更好的学习资源。 diff --git a/eBook/03.6.md b/eBook/03.6.md index 3a68789..c9fa815 100644 --- a/eBook/03.6.md +++ b/eBook/03.6.md @@ -1,19 +1,19 @@ -##啊哦,亲,你看得也太快了。。。还没翻译完呢 0 0 -要不等到 ***2013 年 4 月 22 日*** 再来看看吧~~ - -这里还有一些其它的学习资源噢~ - - - [《Go编程基础》](https://github.com/Unknwon/go-fundamental-programming):已更新至 [第八课](https://github.com/Unknwon/go-fundamental-programming/blob/master/lecture8/lecture8.md) - - [《Go Web编程》](https://github.com/astaxie/build-web-application-with-golang) - -神马?你说你不想学习?那好吧,去逛逛论坛看看行情也行~ - -- [Golang中文社区](http://bbs.mygolang.com/forum.php) -- [Go语言学习园地](http://studygolang.com/) -- [Golang中国](http://golang.tc) - #3.6 生成代码文档 +`go doc` 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档。 +它也可以作为一个提供在线文档浏览的 web 服务器,[http://golang.org](http://golang.org) 就是通过这种形式实现的。 + +**一般用法** + +- `go doc package` 获取包的文档注释,例如:`go doc fmt` 会显示使用 `godoc` 生成的 `fmt` 包的文档注释。 +- `go doc package/subpackage` 获取子包的文档注释,例如:`go doc container/list`。 +- `go doc package function` 获取某个函数在某个包中的文档注释,例如:`go doc fmt Printf` 会显示有关 `fmt.Printf()` 的使用说明。 + +这个工具只能获取在 Go 安装目录下 `.../go/src/pkg` 中的注释内容。此外,它还可以作为一个本地文档浏览 web 服务器。在命令行输入 `godoc -http=:6060`,然后使用浏览器打开 [http://localhost:6060](http://localhost:6060) 后,你就可以看到本地文档浏览服务器提供的页面。 + +`godoc` 也可以用于生成非标准库的 Go 源码文件的文档注释(第 9.6 章)。 + +如果想要获取更多有关 `godoc` 的信息,请访问该页面:[http://golang.org/cmd/godoc/](http://golang.org/cmd/godoc/) ##链接 - [目录](directory.md) diff --git a/eBook/03.7.md b/eBook/03.7.md new file mode 100644 index 0000000..1e605e6 --- /dev/null +++ b/eBook/03.7.md @@ -0,0 +1,21 @@ +##啊哦,亲,你看得也太快了。。。还没翻译完呢 0 0 +要不等到 ***2013 年 4 月 22 日*** 再来看看吧~~ + +这里还有一些其它的学习资源噢~ + + - [《Go编程基础》](https://github.com/Unknwon/go-fundamental-programming):已更新至 [第八课](https://github.com/Unknwon/go-fundamental-programming/blob/master/lecture8/lecture8.md) + - [《Go Web编程》](https://github.com/astaxie/build-web-application-with-golang) + +神马?你说你不想学习?那好吧,去逛逛论坛看看行情也行~ + +- [Golang中文社区](http://bbs.mygolang.com/forum.php) +- [Go语言学习园地](http://studygolang.com/) +- [Golang中国](http://golang.tc) + +#3.7 其它工具 + + +##链接 +- [目录](directory.md) +- 上一节:[生成代码文档](03.6.md) +- 下一节:[Go 性能说明](03.8.md) \ No newline at end of file diff --git a/eBook/directory.md b/eBook/directory.md index cce9281..906b591 100644 --- a/eBook/directory.md +++ b/eBook/directory.md @@ -22,6 +22,7 @@ - 3.5 [格式化代码](03.5.md) - 3.6 [生成代码文档](03.6.md) - 3.7 [其它工具](03.7.md) + - 3.8 [Go 性能说明](03.8.md) ##第二部分:语言的核心结构与技术 - 第4章:基本结构和基本数据类型