前言

1.注释的定义

注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂，一看就知道这段代码是做什么用的。正确的程序注释一般包括序言性注释和功能性注释。序言性注释的主要内容包括模块的接口、数据的描述和模块的功能。模块的功能性注释的主要内容包括程序段的功能、语句的功能和数据的状态。

2.注释的作用

注释只是为了提高可读性，不会被计算机编译。

一、Go代码注释

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

1.单行注释

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

快捷键：ctrl+c

// Add 两数相加（这一行会被截取为简短介绍）
// 两数相加的注意事项以及原理（这一行作为超级详细的介绍）
func Add(n1,n2 int)int{return n1+n2
}

2.多行注释

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

快捷键：shift+ctrl+c

/*
regexp 包为正则表达式实现了一个简单的库。该库接受的正则表达式语法为：regexp:concatenation { '|' concatenation }concatenation:{ closure }closure:term [ '*' | '+' | '?' ]term:'^''$''.'character'[' [ '^' ] character-ranges ']''(' regexp ')'
*/
package regexp

总结

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

【愚公系列】2022年07月 Go教学课程 004-Go代码注释相关推荐

【愚公系列】2022年07月 Go教学课程 005-变量
文章目录一.变量 1.变量的定义 2.变量的作用 3.变量的声明和初始化 3.1 变量的声明 3.2 变量的初始化 3.3 变量的赋值 3.4 案例:交换两个变量的值总结一.变量 1.变量的定义 ...
【愚公系列】2022年04月 Python教学课程 63-DRF框架安装与配置
文章目录前言一.环境安装与配置二.安装三.案例 1.settings.py配置 2.urls.py使用前言 Django REST框架是一个强大而灵活的工具包,用于构建Web API. 您可 ...
【愚公系列】2022年04月 Python教学课程 78-VUE组件中的数据和属性
文章目录前言一.数据的绑定 1.数据绑定二.组件的使用 1.全局组件和局部组件三.组件传值前言因为是Python系列只是简单介绍VUE的基本使用. 组件是Vue中的一个重要概念,是一个可以 ...
【愚公系列】2022年01月 Java教学课程 73-反射
文章目录一.反射 1.反射的概述 2.获取Class类对象的三种方式 3.反射获取构造方法并使用 1.Class类获取构造方法对象的方法 2.Constructor类用于创建对象的方法 3.小结 4 ...
【愚公系列】2022年01月 Java教学课程 80-软件开发介绍
文章目录前言一.JavaWeb开发 1.JavaEE规范 2.Web概述 3.系统结构 3.1系统结构简介 3.2 C/S结构 3.3 B/S结构 3.4 两种结构的区别及优略前言软件开发是根 ...
【愚公系列】2022年01月 Java教学课程 71-自建HTTP服务器解析浏览器请求案例
文章目录一.自建HTTP服务器解析浏览器请求案例 1.环境搭建 2.获取请求信息并解析 3.给浏览器响应数据 4.代码优化一.自建HTTP服务器解析浏览器请求案例 1.环境搭建实现步骤编写Ht ...
【愚公系列】2022年04月 Python教学课程 62-DRF框架介绍
文章目录一.DRF简介二.DRF的特点三.DRF增删改查一.DRF简介 Django REST framework框架是一个用于构建WebAPl的强大而又灵活的工具.通常简称为DRF框架或RE ...
【愚公系列】2022年01月 Java教学课程 84-HTTP协议
文章目录一.HTTP协议 1. HTTP协议概述 1.1 HTTP协议概念 1.2 HTTP协议版本 1.3 HTTP协议相关说明 2. HTTP协议组成 2.1请求部分 2.2 响应部分 2.3 ...
【愚公系列】2022年01月 Java教学课程 52-File文件操作
文章目录一.File文件操作 1.File类概述和构造方法 2.绝对路径和相对路径 3.File类创建功能 4.File类删除功能 5.File类判断和获取功能 6.File类练习一 7.File类 ...
【愚公系列】2022年01月 Java教学课程 46-获取对象操作类Optional
文章目录一.Optional 1.获取对象 2.常用方法 3.处理空指针的方法一.Optional 1.获取对象 Optional概述可能包含或不包含非null值的容器对象方法介绍方法名说 ...

【愚公系列】2022年07月 Go教学课程 004-Go代码注释

文章目录

前言