Go语言学习笔记 - 包

工用空间

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


package folder

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

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

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

源文件

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

包结构

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

  • 源文件头部以"package <name>"声明包名称。
  • 包由同一目录下的多个源码文件组成。
  • 包名类似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列表说明。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 198,932评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,554评论 2 375
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 145,894评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,442评论 1 268
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,347评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,899评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,325评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,980评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,196评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,163评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,085评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,826评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,389评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,501评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,753评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,171评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,616评论 2 339

推荐阅读更多精彩内容