代码规范

文件注释

file - File and code templetes -Go File 添加快捷键

// @Title 
// @Description  (${DATE}  ${TIME})   mick 
package ${GO_PACKAGE_NAME}

函数注释(fn)

file - Edit - Live Templetes 添加快捷键

// @title  
// @description   $DATE$   $TIME$  mick  
// @param   id       int      "id"
// @return  err      error    "错误"
// TODO  第一步
// TODO  第二步
// TODO  第三步

方法注释(sw)

// @Title 
// @Description  $DATE$  $TIME$ mick 
// @Param   openId     header     string  true      "token"
// @Param   id         formData   int     true      "id{1,}"
// @Success 200 {object} $MODELS$
// @Failure 10 数据错误请稍后重试
// @router /$NAME$ [post]
// TODO  第一步
// TODO  第二步
// TODO  第三步

函数与方法

• 命名规范: 严格采用小驼峰的命名方式
• 代码块行数: 10-15行，超过部分需在注释中备注，养成功能模块拆分的思维