2.7　注释

软件往往是一个非常复杂的工程项目，在编写代码的时候，为了更好地让人理解API的用法或者内部实现的处理逻辑，经常需要对核心的代码进行说明。注释是给人看的，不具有实际软件的功能，它的主要作用就是为了增强代码的可读性。

Go语言的注释主要分成两类：

·　单行注释//

·　多行注释/* */

好的源代码（即源程序代码）往往有一些注释即可，而不好的源代码则需要比较多的注释才能看懂。代码的可读性对于软件来说很重要，因为所有的源代码都是由人编写的，也需要在不同的人之间进行协作，因此肯定会供他人阅读。如果一段源代码根本无法读懂，就无法进行后期的维护。

下面给出带有注释的Go语言示例程序2-21。

示例程序2-21　注释示例：chapter02\code07\opt_note.go

在示例程序2-21中，第05行是单行注释，第07～09行是多行注释。好的源代码往往是自解释性的，比如命名比较好的变量或者常量往往从它们的名字就能大致了解其用途。按照规范来说，对外暴露的API或者常量等都应该要进行注释。