golang代码注释规范.pdfVIP

golang代码注释规范 注释规范 包注释 每个包都应该有⼀个包注释，⼀个位于 package ⼦句之前的块注释或⾏注释。包如果有多个 go ⽂件，只需要出现在⼀个 go ⽂件中 （⼀般是和包同名的⽂件）即可。 包注释应该包含下⾯基本信息(请严格按照这个顺序，简介，创建⼈，创建时间）： // @Title // @Description // @Author 创建⼈ 创建时间 // @Update 创建⼈ 修改时间 结构（接⼝）注释 每个⾃定义的结构体或者接⼝都应该有注释说明，该注释对结构进⾏简要介绍，放在结构体定义的前⼀⾏，格式为： 结构体名， 结构 体说明。同时结构体内的每个成员变量都要有说明，该说明放在成员变量的后⾯（注意对齐），实例如下： // User ， ⽤户对象，定义了⽤户的基础信息 type User struct{ UserName string `description:⽤户名称` Email string `description:邮箱` } 函数 注释 // @Title 标题 // @Description 详细信息 // @Auth 创建时间 创建⼈ // @Param 参数类型 参数介绍 // @Return 返回类型 错误信息