【愚公系列】2022 年 7 月 Go 教学课程 004-Go 代码注释
前言
1.注释的定义
注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂,一看就知道这段代码是做什么用的。正确的程序注释一般包括序言性注释和功能性注释。序言性注释的主要内容包括模块的接口、数据的描述和模块的功能。模块的功能性注释的主要内容包括程序段的功能、语句的功能和数据的状态。
2.注释的作用
注释只是为了提高可读性,不会被计算机编译。
一、Go 代码注释
Go 语言的注释主要分成两类,分别是单行注释和多行注释。
1.单行注释
单行注释简称行注释,是最常见的注释形式,可以在任何地方使用以//
开头的单行注释;
快捷键:ctrl+c
复制代码
2.多行注释
多行注释简称块注释,以/*
开头,并以*/
结尾,且不可以嵌套使用,多行注释一般用于包的文档描述或注释成块的代码片段。
快捷键:shift+ctrl+c
复制代码
总结
注释在程序中的作用是对程序进行注解和说明,便于对源码的阅读。编译系统在对源代码进行编译时会自动忽略注释的部分,因此注释对于程序的功能实现不起任何作用。在源码中适当地添加注释,能够提高源码的可读性。
版权声明: 本文为 InfoQ 作者【愚公搬代码】的原创文章。
原文链接:【http://xie.infoq.cn/article/211687fe68e225306ca69b461】。文章转载请联系作者。
评论