Go语言学习笔记 － 包

工用空间

编译工具对源码目录有严格的要求，每个工作空间（workspace）必须由bin、pkg、src三个目录组成。

package folder

　　可在 GOPATH 环境变量列表中添加多个工作空间,但不能和 GOROOT 相同。

export GOPATH=$HOME/projects/golib:$HOME/projects/go

通常 go get 使用用第一个工作空间保存下载的第三方库。

源文件

编码:源码文件必须是 UTF-8 格式,否则会导致编译器出错。
结束:语句以 ";" 结束,多数时候可以省略。
注释:支持 "//"、"/**/" 两种注释方式,不能嵌套。
命名:采用 camelCasing ⻛风格,不建议使用下划线。

包结构

所有代码都必须组织在package中。

• 源文件头部以"package "声明包名称。
• 包由同一目录下的多个源码文件组成。
• 包名类似namespace，与包所在的目录名、编译文件名无关。
• 目录名最好不用main、all、std这三个保留名称。
• 可执行文件必须包含package main，入口函数main。

说明:os.Args 返回命令行参数,os.Exit 终止进程。
要获取正确的可执行文件路径,可用 filepath.Abs(exec.LookPath(os.Args[0]))。

包中成员以名称首字母大小写决定访问权限。

• public：首字母大写，可被包外访问。
• private：首字母小写，仅包内成员可访问。

该规则适用于全局变量、全局常量、类型、结构字段、函数、方法等。

导入包

使用包成员前，必须先用import关键字导入，但不能形成导入循环。在导入时,可指定包成员访问方式。比如对包重命名,以避免同名冲突。未使用的导入包,会被编译器视为错误 (不包括 "import _")。对于当前目录下的子包,除使用默认完整导入路径外,还可使用 local 方式。

import "相对目录/包主文件夹名"

初始化

初始化函数：

• 每个源文件都可以定义一个或多个初始化函数。
• 编译器不保证多个初始化函数的执行次序。
• 初始化函数在单一线程被调用，仅执行一次。
• 初始化函数在包所有全局变量初始化后执行。
• 在所有初始化函数结束后才执行main.main。
• 无法调用初始化函数。
  　　因为无法保证初始化函数执行顺序，因此全局变量应该直接用var初始化。

不应该滥用初始化函数,仅适合完成当前文件中的相关环境设置。

文档

扩展工具godoc能自动提取注释生成帮助文档。

• 仅和成员相邻（中间没有空行）的注释被当做帮助信息。
• 相邻行会合并成同一段落，用空行分隔段落。
• 缩进表示格式化文本，比如示例代码。
• 自动转换URL为链接。
• 自动合并多个源码文件中的package文档。
• 无法显示package main中的成员文档。

package

• 建议用专门的doc.go保存package帮助信息。
• 包文档第一句（中英文句号结束）被当做packages列表说明。