Go语言怎么写注释_Go语言代码注释规范教程【通俗】

pGo仅支持//单行和/ /多行注释前者用于文档注释影响godoc后者不可嵌套注释不编译进二进制但过期注释比无注释更危险。/pGo 语言注释没有“规范教程”这回事——只有官方明确支持的两种写法其他全是无效或危险操作。怎么写单行注释用 //不是 # 也不是 /* */ 套单行Go 只认 // 开头的单行注释后面所有内容直到换行都被忽略。常见错误是抄 Python 或 Shell 习惯写 #结果编译直接报错syntax error: unexpected #。// 后面建议空一格比如 // 返回用户ID不是 //返回用户ID不影响运行但 go fmt 会自动加空格别在 func 签名中间插 //比如 func foo() // 这里不能断行 —— Go 不允许语句跨行中断会报 syntax error: unexpected newline注释不能出现在字符串字面量里hello // world 中的 // 不是注释就是普通字符怎么写多行注释只用 /* */且不能嵌套/* */ 是唯一合法的多行注释形式但 Go 明确禁止嵌套写 /* outer /* inner */ outer end */ 会导致编译失败报错 unexpected /* 或提前截断逻辑。实际开发中极少用 /* */因为 go fmt 不处理它里面的缩进容易让代码块错位更麻烦的是如果误删了结尾的 */整个文件可能被当成一块注释报一堆 expected }, found EOF导出函数/类型前的文档注释必须用 //连续多行不是 /* */ —— 否则 godoc 和 IDE 无法提取比如// User 表示一个系统用户br// 字段需公开首字母大写才能被外部包访问brtype User struct {br ID intbr Name stringbr}注释会被编译进二进制吗不会但文档注释影响 godoc 输出所有 // 和 /* */ 在编译时完全剔除不占二进制体积、不参与任何运行时行为。但以 // 开头、紧贴在导出标识符首字母大写的 func/type/const上方的连续注释块会被 godoc 提取为文档。 RedClaw 百度推出的手机端万能AI Agent助手