Go语言命名方式:
1. 包(Package)
- 包名应该简洁,并且使用小写字母。不应该使用下划线或者混合大小写字母。
- 包名通常反映其功能或内容。例如,标准库中的
fmt
包用于格式化输入输出,net/http
包用于HTTP协议的实现。
2. 变量(Variables)
- 变量名应该具有描述性,清晰地表达变量的用途或内容。
- 变量名使用驼峰式命名法(CamelCase),即如果变量名由多个单词组成,从第二个单词开始每个单词的首字母大写。但是,对于私有变量(即仅在定义它们的包内部可访问的变量),其首字母小写,表示私有访问级别。
- 避免使用下划线开头或结尾,以及双下划线(
__
),这些在Go中有特殊含义或约定。
3. 常量(Constants)
- 常量名通常全部使用大写字母,并使用下划线分隔单词(称为蛇形命名法,Snake_Case),以区分于变量。
- 这种命名方式有助于在代码阅读时快速区分常量和变量。
4. 函数(Functions)
- 函数名应该反映其功能。
- 对于公开的函数(即包外可访问的函数),其命名遵循驼峰式命名法,并且首字母大写。
- 对于包内私有的函数,其命名首字母小写。
5. 自定义类型(Types)
- 自定义类型(包括结构体、接口等)的命名也遵循驼峰式命名法。
- 对于公开的自定义类型,其名称首字母大写。
- 对于私有的自定义类型,其名称首字母小写。1.3、 Go命令
Go语言缩进
选中代码,使用一次 tab 操作,实现缩进,默认整体向右边移动,用 shift+tab 整体向左移
代码格式
Go语言对代码格式有严格的要求,这有助于保持代码的一致性和美观。
- 花括号风格:遵循K&R风格,即左花括号
{
不单独占一行,而是与条件或语句在同一行末尾,右花括号}
则单独占一行。 - 缩进和空格:使用制表符(Tab)进行缩进,每个缩进级别为一个制表符。在操作符、逗号、分号等符号后添加空格以提高可读性。
- 导入语句:导入的包应分组放置,标准库包在前,第三方包在后,每组之间留一个空行。
注释和文档
Go语言鼓励使用注释来解释代码的意图和复杂逻辑,以提高代码的可读性。
- 单行注释:使用
//
开头,后跟注释内容。 - 多行注释:使用
/*
开头,*/
结尾,可以跨越多行。 - 文档注释:对于包、函数、类型等,使用
///
开头并在其上方直接书写的注释会被视为文档注释,这些注释可以通过godoc
工具自动生成文档。
编码规范
Go语言有一些编码上的规范,旨在减少错误和提高代码质量。
- 错误处理:Go鼓励显式地处理错误,而不是忽略它们。使用
if err != nil {...}
模式来检查和处理错误是一种常见的做法。 - 避免不必要的复杂性:Go语言的设计哲学之一是“简单即好”,因此应避免编写过于复杂的代码。当需要处理复杂逻辑时,应将其分解为更小的函数或方法。
- 使用标准库:Go的标准库提供了大量的实用功能和类型,应优先考虑使用它们而不是引入第三方库。
工具支持
Go语言提供了gofmt
工具来自动格式化代码,以确保所有Go代码都遵循统一的风格。使用gofmt
可以大大减少因代码风格不一致而引起的争议和合并冲突。
Go语言官方文档
Golang 官方网站
Golang 官方标准库API
Golang 中文网官方标准库API
Go语言标准库文档中文版 | Go语言中文网 | Golang中文社区 | Golang中国
Golang文件名:
所有的go源码都是以 ".go" 结尾。