第九章修改 (#841)

Co-authored-by: Joe Chen <jc@unknwon.io>
This commit is contained in:
Haigang Zhou
2022-05-11 02:04:17 +08:00
committed by GitHub
parent 30ca13a369
commit 471d59af32
11 changed files with 80 additions and 70 deletions

View File

@@ -1,27 +1,29 @@
# 9.6 为自定义包使用 godoc
godoc 工具(第 3.6 节)在显示自定义包中的注释也有很好的效果:注释必须以 `//` 开始并无空行放在声明类型函数前。godoc 会为每个文件生成一系列的网页。
godoc 工具([第 3.6 节](03.6.md))在显示自定义包中的注释也有很好的效果:注释必须以 `//` 开始并无空行放在声明类型函数前。godoc 会为每个文件生成一系列的网页。
例如:
- 在 [doc_examples](examples/chapter_9/doc_example) 目录下我们有第 11.7 节中的用来排序的 go 文件,文件中有一些注释(文件需要未编译)
- 在 [doc_examples](examples/chapter_9/doc_example) 目录下我们有[第 11.7 节](11.7.md)中的用来排序的 go 文件,文件中有一些注释(文件需要未编译)
- 命令行下进入目录下并输入命令:
godoc -http=:6060 -goroot="."
`godoc -http=:6060 -goroot="."`
`.` 是指当前目录,-goroot 参数可以是 `/path/to/my/package1` 这样的形式指出 package1 在你源码中的位置或接受用冒号形式分隔的路径,无根目录的路径为相对于当前目录的相对路径)
`.` 是指当前目录,`-goroot` 参数可以是 `/path/to/my/package1` 这样的形式指出 `package1` 在你源码中的位置或接受用冒号形式分隔的路径,无根目录的路径为相对于当前目录的相对路径)
- 在浏览器打开地址http://localhost:6060
然后你会看到本地的 godoc 页面(详见第 3.6 节)从左到右一次显示出目录中的包:
然后你会看到本地的 godoc 页面(详见[第 3.6 节](03.6.md))从左到右一次显示出目录中的包:
```
doc_example:
doc_example | Packages | Commands | Specification
```
下面是链接到源码和所有对象时有序概述(所以是很好的浏览和查找源代码的方式),连同文件/注释:
sort 包
`sort`
```go
func Float64sAreSorted
@@ -83,7 +85,7 @@ Convenience wrappers for common cases: type IntArray[Top]
Convenience types for common cases: IntArray type IntArray []int
```
如果你在一个团队中工作,并且源代码树被存储在网络硬盘上,就可以使用 godoc 给所有团队成员连续文档的支持。通过设置 `sync_minutes=n`,你甚至可以让它每 n 分钟自动更新您的文档!
如果你在一个团队中工作,并且源代码树被存储在网络硬盘上,就可以使用 godoc 给所有团队成员连续文档的支持。通过设置 `sync_minutes=n`,你甚至可以让它每 `n` 分钟自动更新您的文档!
## 链接