golang 代码注释规范

注释规范

包注释

每个包都应该有一个包注释,一个位于 package 子句之前的块注释或行注释。包如果有多个 go 文件,只需要出现在一个 go 文件中(一般是和包同名的文件)即可。 包注释应该包含下面基本信息(请严格按照这个顺序,简介,创建人,创建时间):

// @Title 
// @Description 
// @Author 创建人 创建时间
// @Update  创建人 修改时间

结构(接口)注释

 

每个自定义的结构体或者接口都应该有注释说明,该注释对结构进行简要介绍,放在结构体定义的前一行,格式为: 结构体名, 结构体说明。同时结构体内的每个成员变量都要有说明,该说明放在成员变量的后面(注意对齐),实例如下:

 

// User , 用户对象,定义了用户的基础信息
type User struct{
    UserName  string `description:"用户名称"`
    Email     string `description:"邮箱"`
}

函数 注释

// @Title 标题
// @Description 详细信息
// @Auth 创建时间 创建人
// @Param 参数类型 参数介绍
// @Return 返回类型 "错误信息"