当你学习新的语言时，需要学习的基本内容是数据类型、控制流语句和注释，在这篇博文中，你将了解到不同类型的注释以及如何在Go语言中写注释？
在编程语言中，注释是描述代码行语句的有用语句。注释是程序的一部分，包含用于放置人类可读信息的语句。这将有助于开发人员维护代码，提高代码质量，并易于找到错误和修复。
在Golang中，注释是用来描述有关变量、控制结构、函数或任何一行代码的信息。当程序被编译时，注释会被编译器忽略。
关于Golang中的注释的重要观点
- 注释对开发者维护代码非常有用
- 这些注释会被编译器和解释器忽略
- 这些是为变量、变数、方法、条件块或任何一行代码定义的行语句。
- 代码的文档注释
Go语言提供了以下类型的注释
- 单行注释
- 多行注释 - 块注释
- 文档注释
Single-line Comment 总是以两个正斜杠(\\ )为前缀，用于注释单行语句。单行注释用于描述该行代码，可以放在该行代码之前或代码的末尾。
以下是单行注释的语法 语法
// Comments here(Statement of a line are comments)
Golang编译器忽略了// 和行尾之间的任何文本或语句。下面的例子放置了两个单行注释，//主函数 - 这些注释放置在函数声明之前//打印文本到控制台 - 这些注释放置在代码行的末尾。下面是一个单行注释的例子
package main
import (
"fmt"
)
// Main function
func main() {
fmt.Println("Hello World") // Print Text to console
}
块状注释是将注释语句放在多行中，因此它也被称为multi line comments 。
我们可以用单行语法来写多行注释，但是每一行都以// 符号开始，而且在每一行中加入// 符号是没有必要的。因此，多行注释对开发人员来说是很有用的，可以帮助他们获得干净的代码。多行注释是用来在多行中放置注释/语句的。
以下是多行注释的语法 语法
/* This
is a multi line
comments */
注释是以/*开始，以*/结束。Golang编译器会忽略/*和*/之间的语句或文本。下面是一个Golang中多行注释的例子
package main
/* This program example prints
Hello world text to console
*/
import (
"fmt"
)
// Main function
func main() {
// Print Text to console
fmt.Println("Hello World")
}
文档注释是用来为Golang代码创建文档API的。这些注释用于为包或项目生成文档HTML页面，可供用户参考。这些注释包含HTML标记和文本。你需要使用Godoc tooll来创建Go文档API。
package first
/* This program example prints
Hello world text to console
*/
import (
"fmt"
)
/* Adding two numbers
return sum of numbers
*/
func sum(number1 int, number2 int) int {
return number1 + number2
}
// Main function - entry point
func main() {
// Print Text to console
fmt.Println("Hello World")
}
Godoc提供了一个网络服务器。请运行下面的命令来启动一个网络服务器
并在浏览器中打开localhost:8331。
结语
总之，我们可以写单行和多行的注释，帮助开发者获得干净的代码。同时也学会了如何编写文档注释，帮助API用户理解其他开发者编写的代码。
