注释的作用是对程序进行解释和说明。编译系统在编译代码时会自动忽略注释,因此注释对于程序的功能实现不起任何作用。在程序中适当添加注释可以提高程序的可读性。为程序添加注释可以起到以下两种作用。
(1)解释程序某些语句的作用和功能,使程序更易于理解,通常用于代码的解释说明。
(2)用注释屏蔽一部分代码,使编译系统暂时忽略被注释的代码,等需要时再取消注释,这些代码就会再次发挥作用,通常用于代码的调试。
Go语言提供两种注释符号:“//”和“/*…*/”。其中,“//”用于单行注释,“/*…*/”用于多行注释。
单行注释
单行注释也叫行注释,是最常见的注释形式,可以在代码中的任何地方使用以//开头的单行注释。单行注释的格式如下。
//单行注释
多行注释
多行注释也叫块注释,分为开始和结束两部分,在需要注释的内容前输入“/*”表示注释开始,在注释内容结束后输入“*/”表示注释结束。多行注释一般用于描述包的文档或注释代码片段。多行注释的格式如下。
/* 第一行注释 第二行注释 ...... */
(1)在多段注释之间可以使用空行分隔加以区分。
(2)对于代码中的变量、常量、函数等最好也应当加上对应的注释,有利于后期代码维护。