1、单行注释
Go 单行注释以 // 开头
// 这是单行注释 fmt.Println("Hello, World")
注释放在一行末尾:
fmt.Println("Hello, World") // 输出一句话
注释掉代码,不会执行:
// fmt.Println("Hello, World")
fmt.Println("Hello, cjavapy")2、多行注释
Go 的多行注释使用 /* */
/*
这是一段多行注释
用于说明多行内容
*/
fmt.Println("Hello, Go")3、文档注释(GoDoc)
GoDoc 是以 // 开头,但必须紧贴在函数、结构体、包上面,用来生成官方文档。
例如,
函数文档注释:
// Greet 用来问候某个人// 参数 name:人的名字// 返回:问候语字符串funcGreet(name string) string { return"Hello, " + name }
结构体说明:
// Person 表示一个人的结构体// 包含姓名属性type Person struct { Name string } // Greet 问候方法func(p Person) Greet() string { return"Hello, " + p.Name }
Go 文档生成方式:
终端执行:
go doc Person
也可通过 godoc 工具自动生成浏览文档。
总结
| 方式 | 写法 | 用途 |
|---|---|---|
| 单行注释 | // | 最常用 |
| 多行注释 | /* */ | 适合多行解释 |
| GoDoc 注释 | // 顶在类型/函数/包上方 | 用于生成文档说明 |