Golang的注释

注释符号

注释不会被编译,便可以通过 godoc 工具来显示

单选注释,在任何地址 以 “//” 开头,后面都是注释内容

块注释[多行注释],以 "/*" 开头,并以 "*/" 结尾,在其间的内容都是注释内容

注释分类

package 之前的块注释,默认为整个包的说明,最好提供此包的相关信息或整体功能的简介,一个可能有多个文件,但说明,只需要写在一个文件里面就可以。

一般在首行的简要注释之后,空一行,再使用段注释进行详细的说明

// 这是包的首行说明内容,下面会空一行之后,再是详细说明
// 
// 这才是整个包的功能详细说明,与上面的要空一行
package tools

其它的变量、函数、方法与被导出的对象等,都应该有个合理的注释说明,其注释最好以其 字面量 开头进行说明,如下:

// Sum 计算两个数的和,并返回
func Sum(a, b int) int {
  reutrn a+b;
}