命名规范

在任何语言开发中，都有其语言领域的一些命名规范，好的命名可以：

• 降低代码阅读成本
• 降低维护难度
• 降低代码复杂度

规范建议

在我们实际开发中，有很多开发人可能是由某一语言转到另外一个语言领域，在转到另外一门语言后， 我们都会保留着对旧语言的编程习惯，在这里，我建议的是，虽然不同语言之前的某些规范可能是相通的， 但是我们最好能够按照官方的一些demo来熟悉是渐渐适应当前语言的编程规范，而不是直接将原来语言的编程规范也随之迁移过来。

命名准则

• 当变量名称在定义和最后一次使用之间的距离很短时，简短的名称看起来会更好。
• 变量命名应尽量描述其内容，而不是类型
• 常量命名应尽量描述其值，而不是如何使用这个值
• 在遇到for，if等循环或分支时，推荐单个字母命名来标识参数和返回值
• method、interface、type、package推荐使用单词命名
• package名称也是命名的一部分，请尽量将其利用起来
• 使用一致的命名风格

文件命名规范

• 全部小写
• 除unit test外避免下划线(_)
• 文件名称不宜过长

变量命名规范参考

• 首字母小写
• 驼峰命名
• 见名知义，避免拼音替代英文
• 不建议包含下划线(_)
• 不建议包含数字

适用范围

• 局部变量
• 函数出参、入参

函数、常量命名规范

• 驼峰式命名
• 可exported的必须首字母大写
• 不可exported的必须首字母小写
• 避免全部大写与下划线(_)组合

路由规范

• 推荐脊柱式命名
• 小写单词、横杠(-)组合
• 见名知义

/user/get-info
/user/get/info
/user/password/change/:id

编码规范

import

• 单行import不建议用圆括号包裹

• 按照官方包，NEW LINE，当前工程包，NEW LINE，第三方依赖包顺序引入

    import (
        "context"
        "string"
  
        "greet/user/internal/config"
  
        "google.golang.org/grpc"
    )

函数返回

• 对象避免非指针返回
• 遵循有正常值返回则一定无error，有error则一定无正常值返回的原则

错误处理

• 有error必须处理，如果不能处理就必须抛出。
• 避免下划线(_)接收error

函数体编码

• 建议一个block结束空一行，如if、for等

    func main (){
        if x==1{
            // do something
        }
  
        fmt.println("xxx")
    }

• return前空一行

    func getUser(id string)(string,error){
        ....
  
        return "xx",nil
    }