Docs

最全 Go 编码规范

输入“/”快速插入

最全 Go 编码规范

在 Go 项目开发中，一个好的编码规范可以极大地提高代码质量。为了帮你节省时间和精力，这里我整理了一份清晰、可直接套用的 Go 编码规范，供你参考。​

这份规范，是我参考了 Go 官方提供的编码规范，以及 Go 社区沉淀的一些比较合理的规范之后，加入自己的理解总结出的，它比很多公司内部的规范更全面，你掌握了，以后在面试大厂的时候，或者在大厂里写代码的时候，都会让人高看一眼，觉得你 code 很专业。​

这份编码规范中包含代码风格、命名规范、注释规范、类型、控制结构、函数与方法、GOPATH 设置规范、依赖管理、代码可维护及可扩展约束、包设计与管理、测试、最佳实践 12 类规范。如果你觉得这些规范内容太多了，看完一遍也记不住，这完全没关系。你可以多看几遍，也可以在用到时把它翻出来，在实际应用中掌握。这篇特别放送的内容，更多是作为写代码时候的一个参考手册。​

提示：比腾讯、字节官方 Go 编码规范，还全的 Go 编码规范，也是全网最全。​

1. 代码风格

1.1 代码格式

•
代码都必须用 gofmt 进行格式化。​

•
运算符和操作数之间要留空格。​

•
建议一行代码不超过 120 个字符，超过部分，请采用合适的换行方式换行。但也有些例外场景，例如 import 行、工具自动生成的代码、带 tag 的 struct 字段。​

•
文件长度不能超过 800 行。​

•
函数长度不能超过 80 行。​

•
import 规范​
◦
代码都必须用goimports进行格式化（建议将 Go 代码编辑器设置为：保存时运行 goimports）。​
◦
不要使用相对路径引入包，例如 import ../util/net 。​
◦
包名称与导入路径的最后一个目录名不匹配时，或者多个相同包名冲突时，则必须使用导入别名。​

    // bad​
    "github.com/dgrijalva/jwt-go/v4"​
​
    //good​
    jwt "github.com/dgrijalva/jwt-go/v4"​

•
导入的包建议进行分组，匿名包的引用使用一个新的分组，并对匿名包引用进行说明。​

    import (​
    // go 标准包​
    "fmt"​
​
    // 第三方包​
    "github.com/jinzhu/gorm"​
    "github.com/spf13/cobra"​
    "github.com/spf13/viper"​
​
    // 匿名包单独分组，并对匿名包引用进行说明​
    // import mysql driver​
    _ "github.com/jinzhu/gorm/dialects/mysql"​
​
    // 内部包​
    v1 "github.com/marmotedu/api/apiserver/v1"​
    metav1 "github.com/marmotedu/apimachinery/pkg/meta/v1"​
    "github.com/marmotedu/iam/pkg/cli/genericclioptions"​
    )​

1.2 声明、初始化和定义

•
当函数中需要使用到多个变量时，可以在函数开始处使用var声明。在函数外部声明必须使用 var ，不要采用 := ，容易踩到变量的作用域的问题。​

var (​
    Width  int​
    Height int​
)​