This commit is contained in:
Xargin
2016-10-10 15:17:50 +08:00
parent ef1d302ae6
commit 1a5593ac1c
9 changed files with 21 additions and 21 deletions

View File

@@ -2,7 +2,7 @@
Go语言的编码风格鼓励为每个包提供良好的文档。包中每个导出的成员和包声明前都应该包含目的和用法说明的注释。
Go语言中文档注释一般是完整的句子,第一行是包的摘要说明,注释后仅跟着包声明语句。注释中函数的参数或其它的标识符并不需要额外的引号或其它标记注明。例如下面是fmt.Fprintf的文档注释。
Go语言中文档注释一般是完整的句子,第一行通常是摘要说明,以被注释者的名字开头。注释中函数的参数或其它的标识符并不需要额外的引号或其它标记注明。例如下面是fmt.Fprintf的文档注释。
```Go
// Fprintf formats according to a format specifier and writes to w.
@@ -16,7 +16,7 @@ Fprintf函数格式化的细节在fmt包文档中描述。如果注释后仅跟
在本书中,只要空间允许,我们之前很多包声明都包含了注释文档,但你可以从标准库中发现很多更好的例子。有两个工具可以帮到你。
首先是`go doc`命令,该命令打印包的声明和每个成员的文档注释,下面是整个包的文档
首先是`go doc`命令,该命令打印其后所指定的实体的声明与文档注释,该实体可能是一个包
```
$ go doc time
@@ -34,7 +34,7 @@ type Time struct { ... }
...many more...
```
或者是某个具体包成员的注释文档
或者是某个具体包成员:
```
$ go doc time.Since
@@ -44,7 +44,7 @@ func Since(t Time) Duration
It is shorthand for time.Now().Sub(t).
```
或者是某个具体包的一个方法的注释文档
或者是一个方法
```
$ go doc time.Duration.Seconds
@@ -63,7 +63,7 @@ func (dec *Decoder) Decode(v interface{}) error
it in the value pointed to by v.
```
第二个工具名字也叫godoc它提供可以相互交叉引用的HTML页面但是包含和`go doc`命令相同以及更多的信息。10.1演示了time包的文档11.6节将看到godoc演示可以交互的示例程序。godoc的在线服务 https://godoc.org ,包含了成千上万的开源包的检索工具。
第二个工具名字也叫godoc它提供可以相互交叉引用的HTML页面但是包含和`go doc`命令相同以及更多的信息。10.1演示了time包的文档11.6节将看到godoc演示可以交互的示例程序。godoc的在线服务 https://godoc.org ,包含了成千上万的开源包的检索工具。
你也可以在自己的工作区目录运行godoc服务。运行下面的命令然后在浏览器查看 http://localhost:8000/pkg 页面: