环球快看:golang注释有几种

时间:2022-12-08 19:59:31       来源:PHP中文网

本教程操作环境:windows7系统、GO 1.18版本、Dell G3电脑。

注释简介


【资料图】

用于注解说明解释程序的文字就是注释,注释提高了代码的阅读性;

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

注释是一个程序员必须要具有的良好编程习惯。将自己的思想通过注释先整理出来,再用代码去体现。

在 Golang 中注释有两种形式

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

多行注释简称块注释,以/*开头,并以*/结尾,且不可以嵌套使用,多行注释一般用于包的文档描述或注释成块的代码片段。【相关推荐:Go视频教程、编程教学】

1、行注释

单行注释的格式如下所示

//单行注释
登录后复制

举例:

2、块注释(多行注释)

多行注释的格式如下所示

/*第一行注释第二行注释...*/
登录后复制

举例:

3、说明

每一个包都应该有相关注释,在使用 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 {   ...}
登录后复制

4、使用细节

1)对于行注释和块注释,被注释的文字不会被Go编译器执行。

2) 快注释内不允许有块注释嵌套。

更多编程相关知识,请访问:编程视频!!

以上就是golang注释有几种的详细内容,更多请关注php中文网其它相关文章!

关键词: 多行注释 单行注释