注释 #
IDEA注释 #
// 这是一个单行注释
/*
这是一个多行注释
可以用于注释多行代码
*/
函数注释 #
// add 函数将两个整数相加并返回结果
// 参数: a - 第一个整数, b - 第二个整数
// 返回值: 两个整数的和
func add(a, b int) int {
return a + b
}
TODO:英语翻译为待办事项,备忘录。如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME:可以拆成短语,fix me ,意为修理我。如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
// FIXME: 这里有一个需要修复的问题 可小写
// TODO: 添加错误处理代码
添加新的注释格式 #
标签 | 说明 |
---|---|
TODO: | 以后要添加的功能 |
FIXME: | 已知的BUG,以后需要修正 |
HACK: | 代码不太好,需要优化 |
XXX: | 包含所有tag的tag,不好明确到底用哪个tag |
REVIEW: | 虽然好用,最好还是评审一下 |
OPTIMIZE: | 性能不好,需要优化 |
NOTE: | 一些说明 |
WARNING: | 请注意 |
代码报红处理方法 #
设置import规范 #
1、标准库
2、项目包
3、第三方包