golang 开发注释规范

高山丿流水

已于 2023-05-09 14:30:26 修改

阅读量508

点赞数

文章标签： golang 开发语言后端

于 2023-05-09 14:26:49 首次发布

本文链接：https://blog.csdn.net/u011069013/article/details/130579379

版权

Golang代码注解规范

背景

在日常开发中，经常有小伙伴不注解，或者注解内容不规范，在这里统一列一下golang的注解规范。

规范

@Deprecated
弃用结构体(struct),方法 （func), 常量（const)
格式 // Deprecated
例如
 // Deprecated : 使用AC 替换
 type A struct{}


@FIXME
标记需要待修复的内容
格式 // FIXME::改用常量
例如 var a = 1 //FIXME::1使用常量替换

@TODO
标记还未完成的内容
格式 // TODO:: 做什么
例如 type Echo struct{}  // TODO :: 添加 echo 方法