go语言如何注释

go语言注释的方法：1、通过将“//”符号放在单行go语句前面来实现单行注释；2、通过“/*...*/”符号包围需要注释掉的go代码段来实现多行注释。

本文环境：Windows7系统、Go1.11.2版，本文适用于所有品牌的电脑。

推荐：《go语言教程》

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

Go语言的注释主要分成两类，分别是单行注释和多行注释。

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

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

单行注释的格式如下所示

//单行注释

多行注释的格式如下所示

/*第一行注释第二行注释...*/

每一个包都应该有相关注释，在使用 package 语句声明包名之前添加相应的注释，用来对包的功能及作用进行简要说明。

同时，在 package 语句之前的注释内容将被默认认为是这个包的文档说明。一个包可以分散在多个文件中，但是只需要对其中一个进行注释说明即可。

在多段注释之间可以使用空行分隔加以区分，如下所示：

// Package superman implements methods for saving the world.//// Experience has shown that a small number of procedures can prove// helpful when attempting to save the world.package superman

对于代码中的变量、常量、函数等对象最好也都加上对应的注释，这样有利于后期对代码进行维护，例如下面代码中对 enterOrbit 函数的注释：

// enterOrbit causes Superman to fly into low Earth orbit, a position// that presents several possibilities for planet salvation.func enterOrbit() error {   ...}

当开发人员需要了解包的一些情况时，可以使用 godoc 来显示包的文档说明

更多相关技术文章，请访问golang教程栏目！

更多相关文章

随机推荐