Golang注释怎么写_单行与多行注释说明

3次阅读

go单行注释仅支持//,多行注释仅支持/…/且不可嵌套;文档注释是工具约定而非语法特性,需紧贴声明上方;注释不影响编译但影响go doc提取。

Golang注释怎么写_单行与多行注释说明

Go 里单行注释用 //,不是 #/* ... */ 套壳

Go 不支持 python 风格的 #,也不允许用 /* ... */ 包裹单行内容来“假装”是单行注释。只要写在 // 后面、直到行尾的内容,全部被忽略。它可出现在行首,也可跟在语句后面:

  • fmt.Println("hello") // 这是合法的行尾注释
  • // 这是整行注释
  • /* 这种写法在 Go 里是多行注释,哪怕只写一行 */

注意:// 后面如果紧跟着 =+ 等符号(比如 //=),不会被识别为注释起始——Go 要求 // 是独立的标记,中间不能粘连其他字符。

/* ... */ 是唯一多行注释,但不能嵌套

Go 的块注释必须用 /* 开头、*/ 结尾,中间换行无限制。但它不支持嵌套——也就是说,你不能在一段 /* ... */ 里再写一对 /* ... */,否则编译器会在第一个 */ 就结束注释,导致后续代码被误判为注释或语法错误。

  • ✅ 正确:/* 第一行n第二行n第三行 */
  • ❌ 错误:/* 外层 /* 内层 */ 外层继续 */ → 编译失败,报错类似 syntax Error: unexpected */
  • ⚠️ 注意:/**/ 之间可以有任意空白(包括空行),但不能跨 UTF-8 字符边界截断(极少见,但若手动编辑二进制文件或混入非法字节可能触发)

文档注释不是语法特性,而是 go docide 解析约定

Go 没有专门的「文档注释」语法,但约定俗成:紧挨着声明(函数、变量、类型、包)上方的 // 单行注释,或以 /* 开头且紧贴声明的块注释,会被 go docvs code 插件等工具提取为文档。

立即学习go语言免费学习笔记(深入)”;

  • ✅ 会被识别:// Foo 计算 x 的平方 + 下一行是 func Foo(x int) int { ... }
  • ✅ 也会被识别:/* Foo 计算 x 的平方 */ + 换行 + func Foo(x int) int { ... }
  • ❌ 不会被识别:func Foo(x int) int { // 这只是函数体内的普通注释
  • ⚠️ 包级文档建议放在 package xxx 上方,且一个包内最多一个顶层 // Package xxx ... 注释

注释里写代码?别试,go fmt 会帮你删掉

Go 工具链对注释内容不做校验,但 go fmt(以及 gofmt)在格式化时,会自动清理注释中明显像代码却没被正确包裹的片段,比如:

// if x > 0 { //     return true // }

这类注释本身合法,但容易误导维护者。更严重的是,如果注释里混入未闭合的字符串字面量或括号,某些静态分析工具(如 staticcheck)可能误报语法风险。实际开发中,真要保留示例代码,应使用带语言标识的 markdown 代码块(仅限 README 或 godoc 渲染场景),而非源码注释。

真正容易被忽略的是:注释不参与类型检查、不可反射获取、也不会影响编译产物大小——但它会影响 go list -f '{{.Doc}}' 这类元信息提取的准确性,尤其当多人协作维护文档时,注释位置偏移一空行,go doc 就可能返回空字符串。

text=ZqhQzanResources