# 代码规范

  • 包名采用小写单词,尽量简短且能表达包的功能。不要和标准库重名
  • 变量名、函数名采用驼峰式命名法,尽量简洁明了。
  • 常量名全部大写,单词之间用下划线分隔。
  • 接口以 "er" 结尾,如 Reader、Writer 等。或者在最前面加一个大写的 I。也是驼峰。
  • 文件名如果有多个单词可以采用蛇形命名法。user_dao.go

# 注释规范

  • 每个包、类型、函数、常量、变量都应该有注释说明其用途和功能。
  • 注释应该简明扼要,遵循 Godoc 的格式规范。
  • 行内注释应置于代码右侧,并以 // 开头。

# import 规范

分组导入

  • 在  import  语句中,应该将导入的包按功能或来源进行分组,每组使用一个  import  语句。
  • 分组时可以使用括号包裹,或者采用多行导入的方式。
    1
    2
    3
    4
    5
    6
    7
    import (
    "fmt"
    "math"

    "example.com/mylib"
    "github.com/user/myproject"
    )

标准库优先

  • 在导入包时,应该先导入 Go 标准库中的包,然后再导入第三方或自定义包。
  • 这有利于代码的组织和可读性。
更新于 阅读次数

请我喝[茶]~( ̄▽ ̄)~*

colagold 微信支付

微信支付

colagold 支付宝

支付宝