第六届字节跳动青训营笔记三| 青训营

85 阅读2分钟

注释

注释不会被编译,但可以通过 godoc 来使用。

单行注释是最常见的注释形式,你可以在任何地方使用以 // 开头的单行注释。

多行注释也叫块注释,均已以 /* 开头,并以 */ 结尾,且不可以嵌套使用,多行注释一般用于包的文档描述或注释成块的代码片段。

每一个包应该有相关注释,在 package 语句之前的块注释将被默认认为是这个包的文档说明,其中应该提供一些相关信息并对整体功能做简要的介绍。

一个包可以分散在多个文件中,但是只需要在其中一个进行注释说明即可。当开发人员需要了解包的一些情况时,自然会用 godoc 来显示包的文档说明,在首行的简要注释之后可以用成段的注释来进行更详细的说明,而不必拥挤在一起。

另外,在多段注释之间应以空行分隔加以区分。

示例:

// Package superman implements methods for saving the world. 
// 
// Experience has shown that a small number of procedures can prove
// helpful when attempting to save the world. 
package superman

几乎所有全局作用域的类型、常量、变量、函数和被导出的对象都应该有一个合理的注释。如果这种注释(称为文档 注释)出现在函数前面,例如函数 Abcd,则要以 "Abcd..." 作为开头。

示例:

 // enterOrbit causes Superman to fly into low Earth orbit, a position 
 // that presents several possibilities for planet salvation. 
 func enterOrbit() error { 
 ... 
 }

标准库

在 Go 的安装文件里包含了一些可以直接使用的包,即标准库。在 Windows 下,标准库的位置在 Go 根目录下的 子目录 pkg\windows_386 中;在 Linux 下,标准库在 Go 根目录下的子目录 pkg\linux_amd64 中(如果是安 装的是 32 位,则在 linux_386 目录中)。一般情况下,标准包会存放在 GOROOT/pkg/GOROOT/pkg/GOOS_$GOARCH/ 目录 下。 Go 的标准库包含了大量的包(如:fmt 和 os),但是你也可以创建自己的包。 如果想要构建一个程序,则包和包内的文件都必须以正确的顺序进行编译。包的依赖关系决定了其构建顺序。 属于同一个包的源文件必须全部被一起编译,一个包即是编译时的一个单元,因此根据惯例,每个目录都只包含一个包。 如果对一个包进行更改或重新编译,所有引用了这个包的客户端程序都必须全部重新编译。