0

0

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

P粉602998670

P粉602998670

发布时间:2026-02-02 08:01:02

|

840人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

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

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

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

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

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

豆包MarsCode
豆包MarsCode

豆包旗下AI编程助手,支持DeepSeek最新模型

下载
  • ✅ 会被识别:// 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 就可能返回空字符串。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

182

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

229

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

344

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

210

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

397

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

282

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

194

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

498

2025.06.17

go语言 注释编码
go语言 注释编码

本专题整合了go语言注释、注释规范等等内容,阅读专题下面的文章了解更多详细内容。

30

2026.01.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 3.8万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号