go文件命名规范


文件命名

  1. 如果文件名是以 “.” 或者 “_” 开头的话编译的时候会被忽略
  2. 文件名如果是 suffix_test.go are 只会在运行go test的时候才会被编译和运行
  3. 文件名支持系统和architecture来指定系统的编译。文件名支持如下的格式:
    1
    2
    3
    *_GOOS
    *_GOARCH
    *_GOOS_GOARCH
    例如 name_linux.go 只会在 linux 编译, name_amd64.go 只会在 amd64 系统编译. 当然你也可以不用文件名,而是在文件顶端加上这一句 //+build amd64

总结:

  1. golang的命名需要使用驼峰命名法,且不能出现下划线
  2. golang中根据首字母的大小写来确定可以访问的权限。无论是方法名、常量、变量名还是结构体的名称,如果首字母大写,则可以被其他的包访问;如果首字母小写,则只能在本包中使用
  3. 结构体中属性名的大写,如果属性名小写则在数据解析(如json解析,或将结构体作为请求或访问参数)时无法解析
    例:
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    type User struct {
    name string
    age int
    }

    func main() {
    user:=User{"Tom",18}
    if userJSON,err:=json.Marshal(user);err==nil{
    fmt.Println(string(userJSON)) //数据无法解析
    }
    }

    # 结构体中的字段名为小写,导致无法数据解析。因此一般建议结构体中的字段大写

命名规范

  1. 平台区分

    文件名_平台

    例: file_windows.go, file_unix.go

    可选为:windows, unix, posix, plan9, darwin, bsd, linux, freebsd, nacl, netbsd, openbsd, solaris, dragonfly, bsd, notbsd, android,stubs

  2. 测试单元

    文件名test.go或者 文件名平台_test.go

    例: path_test.go, path_windows_test.go
    注意:只有在go test时执行。

  3. 版本区分(猜测)

    文件名_版本号等。
    例:trap_windows_1.4.go

  4. CPU类型区分, 汇编用的多

    文件名_(平台:可选)_CPU类型.
    例:vdso_linux_amd64.go
    可选:amd64, none, 386, arm, arm64, mips64, s390,mips64x,ppc64x, nonppc64x, s390x, x86,amd64p32


文章作者: Murray
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 Murray !
  目录