• 技术文章 >后端开发 >Golang

    golang注释有几种

    青灯夜游青灯夜游2022-12-08 19:18:35原创1976

    golang注释有两种形式:1、单行注释(简称行注释),语法“//单行注释”;2、多行注释(简称块注释),以“/*”开头,并以“*/”结尾,且不可以嵌套使用,语法“/*注释内容...*/”。开发者可以在任何地方使用以“//”开头的单行注释,而多行注释一般用于包的文档描述或注释成块的代码片段。

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

    注释简介

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

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

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

    在 Golang 中注释有两种形式

    1、行注释

    单行注释的格式如下所示

    //单行注释

    举例:

    1.png

    2、块注释(多行注释)

    多行注释的格式如下所示

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

    举例:

    2.png

    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中文网其它相关文章!

    声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn核实处理。
    专题推荐:Golang Go go语言
    上一篇:golang map怎么删除元素 下一篇:自己动手写 PHP MVC 框架(40节精讲/巨细/新人进阶必看)

    相关文章推荐

    • go语言有哪些类型• 一文浅析Golang中的切片(Slice)• go和什么语言接近• go语言的注释编码规范是什么• golang grpc消息过大?教你快速解决!
    1/1

    PHP中文网