本文共 708 字，大约阅读时间需要 2 分钟。

目录

格式化

使用gofmt进行格式化

注释

go有行注释和块注释

行注释

// 行注释

块注释

/*

块注释

*/

包的注释

每个包的前面都应该有注释，来说明包的作用

函数的注释

每个函数前都应该有注释，说明函数的功能，参数，返回值

可导出的变量的注释

每个可导出的变量（首字母大写）都应该有注释

命名规范

• 由26个英文字母大小写，0-9，组成，数字不可以开头
• Golang中严格区分大小写
• 标识符不能包含空格
• 下划线””本身在Go中是一个特殊的标识符，称为空标识符。可以代表任何其它的标识符，但是它对应的值会被忽略（比如：忽略某个返回值）。所以仅能被作为占位符使用，不能作为标识符使用
• 不能以系统保留关键字作为标识符，比如break，if 等等.…

包名

小写单词，简短有意义，尽量和所在文件夹名一致，不要和标准库冲突

-Go

----src

--------errors

-------------errors.go===>package errors

包名为 main 的包为应用程序的入口包

文件名

小写单词，下划线分隔

变量名/函数名/常量名

本包内：

驼峰法：第一个单词小写，如果后面有单词，首字母大写

包外可访问：

帕斯卡命名：每个单词都首字母大写

接口

接口加er后缀，如 Reader、Writer、 Formatter、CloseNotifier 等

缩进

不同层级一个Table（四个空格）

更多Go相关内容：

有问题请下方评论，转载请注明出处，并附有原文链接，谢谢！如有侵权，请及时联系。如果您感觉有所收获，自愿打赏，可选择支付宝18833895206（小于），您的支持是我不断更新的动力。