go语言注释

注释是什么意思

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

注释在程序中的作用是对程序进行注解和说明，便于对源码的阅读。编译系统在对源代码进行编译时会自动忽略注释的部分，因此注释对于程序的功能实现不起任何作用。在源码中适当地添加注释，能够提高源码的可读性。

无论使用何种编程语言，为代码添加注释都是必要的。大多数项目都需要持续一段时间来完成开发和测试，最终上线后还要应对产品的迭代更新。然而，毫不夸张地说，即使仅相隔一周，我们也可能读不懂代码了，哪怕这些代码是自己编写的。此时，注释可以很好地帮助我们理解这些代码。

go语言中的注释

在Go语言中，注释分为两类：单行注释和多行注释。

• 单行注释简称行注释，是最常见的注释形式，可以在任何地方使用以//开头的单行注释；

• 多行注释简称块注释，以/*开头，并以*/结尾，且不可以嵌套使用，多行注释一般用于包的文档描述或注释成块的代码片段。

单行注释

单行注释也称为行注释，格式为以“//”开头的一行，可以被添加在代码的任何位置。

例如，下面这段代码中添加了一行注释，用于解释下一行代码的作用：

package main
import "fmt"
func main(){
    //输出"Hello World!"文字
    fmt.Println("Hello World!")
}

需要注意的是，在使用注释时，不要连同代码一起注释，因为被注释的代码不会被执行。但是在修改代码时，利用这个特性暂时注释掉被修改的代码，而非直接删除，可以很方便地在必要时还原它们。

若要添加空白行，可以按照如下格式实现：

//第1行
//
//第3行
//第4行

多行注释

多行注释也称为块注释，格式为以“/*”开头、以“*/”结束的一行或多行。

例如，在main()函数上方添加多行注释，用于解释main()函数的作用：

/*
main()函数是Go程序的入口函数
是程序运行的起点
此处输出"Hello World!"
用于验证开发环境配置
*/
func main(){
    //输出"Hello World!"文字
    fmt.Println("Hello World!")
}

和单行注释不同，多行注释不允许嵌套使用，因为这将导致编译时错误，从而无法完成编译。示例如下：

/*
main()函数是Go程序的入口函数
/*是程序运行的起点
此处输出"Hello World!"
*/
用于验证开发环境配置
*/

若要添加空白行，可以按照如下格式实现：

/*
第1行

第3行
第4行
*/

代码是写给人看的，养成良好的编码习惯不仅对编码本身有利，还对开发团队中的队友提供了很好的支持。在实际开发中，人员之间的沟通成本可能会庞大到“可怕”的程度，请大家谨记。

这篇好文章是转载于：学新通技术网