fix typo and optimize.

Change-Id: I7b6938936231fd722814984678ffa30402539fd9
This commit is contained in:
fuyc
2016-08-11 17:08:38 +08:00
parent ed57986ea7
commit 8fda418f3a
33 changed files with 128 additions and 126 deletions

View File

@@ -21,6 +21,6 @@ func main() {
关于默认包名一般采用导入路径名的最后一段的约定也有三种例外情况。第一个例外包对应一个可执行程序也就是main包这时候main包本身的导入路径是无关紧要的。名字为main的包是给go build§10.7.3)构建命令一个信息,这个包编译完之后必须调用连接器生成一个可执行程序。
第二个例外包所在的目录中可能有一些文件名是以_test.go为后缀的Go源文件译注前面必须有其它的字符因为以`_`前缀的源文件是被忽略的并且这些源文件声明的包名也是以_test为后缀名的。这种目录可以包含两种包一种普通包加一种则是测试的外部扩展包。所有以_test为后缀包名的测试外部扩展包都由go test命令独立编译普通包和测试的外部扩展包是相互独立的。测试的外部扩展包一般用来避免测试代码中的循环导入依赖具体细节我们将在11.2.4节中介绍。
第二个例外,包所在的目录中可能有一些文件名是以``_test.go``为后缀的Go源文件译注前面必须有其它的字符因为以``_``前缀的源文件是被忽略的并且这些源文件声明的包名也是以_test为后缀名的。这种目录可以包含两种包一种普通包加一种则是测试的外部扩展包。所有以_test为后缀包名的测试外部扩展包都由go test命令独立编译普通包和测试的外部扩展包是相互独立的。测试的外部扩展包一般用来避免测试代码中的循环导入依赖具体细节我们将在11.2.4节中介绍。
第三个例外,一些依赖版本号的管理工具会在导入路径后追加版本号信息,例如"gopkg.in/yaml.v2"。这种情况下包的名字并不包含版本号后缀而是yaml。

View File

@@ -12,7 +12,7 @@ func Fprintf(w io.Writer, format string, a ...interface{}) (int, error)
Fprintf函数格式化的细节在fmt包文档中描述。如果注释后仅跟着包声明语句那注释对应整个包的文档。包文档对应的注释只能有一个译注其实可以有多个它们会组合成一个包文档注释包注释可以出现在任何一个源文件中。如果包的注释内容比较长一般会放到一个独立的源文件中fmt包注释就有300行之多。这个专门用于保存包文档的源文件通常叫doc.go。
好的文档并不需要面面俱到,文档本身应该是简洁但不忽略的。事实上Go语言的风格更喜欢简洁的文档并且文档也是需要像代码一样维护的。对于一组声明语句可以用一个精炼的句子描述如果是显而易见的功能则并不需要注释。
好的文档并不需要面面俱到,文档本身应该是简洁但不忽略的。事实上Go语言的风格更喜欢简洁的文档并且文档也是需要像代码一样维护的。对于一组声明语句可以用一个精炼的句子描述如果是显而易见的功能则并不需要注释。
在本书中,只要空间允许,我们之前很多包声明都包含了注释文档,但你可以从标准库中发现很多更好的例子。有两个工具可以帮到你。

View File

@@ -4,4 +4,4 @@
Go语言有超过100个的标准包译注可以用`go list std | wc -l`命令查看标准包的具体数目标准库为大多数的程序提供了必要的基础构件。在Go的社区有很多成熟的包被设计、共享、重用和改进目前互联网上已经发布了非常多的Go语言开源包它们可以通过 http://godoc.org 检索。在本章,我们将演示如果使用已有的包和创建新的包。
Go还自带了工具箱里面有很多用来简化工作区和包管理的小工具。在本书开始的时候我们已经见识过如何使用工具箱自带的工具来下载、构建和运行我们的演示程序了。在本章我们将看看这些工具的基本设计理论和尝试更多的功能例如打印工作区中包的文档和查询相关的元数据等。在下一章我们将探讨探索包的单元测试用法。
Go还自带了工具箱里面有很多用来简化工作区和包管理的小工具。在本书开始的时候我们已经见识过如何使用工具箱自带的工具来下载、构建和运行我们的演示程序了。在本章我们将看看这些工具的基本设计理论和尝试更多的功能例如打印工作区中包的文档和查询相关的元数据等。在下一章我们将探讨testing包的单元测试用法。