【golang】【注释模版】

@

目录

写在前面

  • 相关博文
  • 个人博客首页
  • 免责声明：仅供学习交流使用！开源框架可能存在的风险和相关后果将完全由用户自行承担，本人不承担任何法律责任。

注释要求

  • 统一使用中文注释，对于中英文字符之间严格使用空格分隔， 这个不仅仅是中文和英文之间，英文和中文标点之间也都要使用空格分隔
    • 全部使用单行注释，禁止使用多行注释
    • 和代码的规范一样，单行注释不要过长，禁止超过 120 字符。

package

// @Title  请填写文件名称（需要改）
// @Description  请填写文件描述（需要改）
// @Author  请填写自己的真是姓名（需要改）  ${DATE} ${TIME}
// @Update  请填写自己的真是姓名（需要改）  ${DATE} ${TIME}
package ${GO_PACKAGE_NAME}

结构体

// User   用户对象，定义了用户的基础信息
type User struct{
    Username  string // 用户名
    Email     string // 邮箱
}

方法

// @title    函数名称
// @description   函数的详细描述
// @auth      作者             时间（2019/6/18   10:57 ）
// @param     输入参数名        参数类型         "解释"
// @return    返回参数名        参数类型         "解释"

代码逻辑注释

// TODO  代码块的执行解释
if   userAge < 18 {

}

参考资料

基础/标准库/第三方库

golang 导航

编程规范

算法｜面试

项目

posted @ 2023-11-21 11:02  Nones  阅读(54)  评论(0)  编辑  收藏  举报