The Go Programming Language Specification - Comments

• 解释一段代码的作用
  让别人在阅读代码的时候能快速了解代码的逻辑。
  让自己以后在阅读代码的时候能回忆起代码的逻辑。
• 说明一段代码的注意点
  在多人协作中，警告其他人不要乱动某段代码，或者是要修改某段代码的时候注意些什么
• 临时去除一些有效代码
  通常在调试代码的时候使用
• 用于生成文档
• 告诉特定工具一些信息
  这通常是一些特殊的注释。比如告诉编译器、编辑器等

注释是给人看的，所以，在运行代码的时候是无用的，在编译的时候golang编译器会把注释去除掉。

一般的，注释内容的量大约占总源码的量的1/3是比较好的。

不写注释是一个不好的习惯。

注释太多会影响源码的阅读。

不要为了写注释而写注释。

语法 ：

// 我是单行注释

示例 ：

// true and false are the two untyped boolean values.
const (
    true  = 0 == 0 // Untyped bool.
    false = 0 != 0 // Untyped bool.
)

语法 ：

/* 我是多行注释 */

/*
我是多行注释 */

/*
我是多行注释
*/

/*

我是多行注释

*/

说明 ：被/*和*/包裹起的都是注释。

示例 ：

/*
    Package builtin provides documentation for Go's predeclared identifiers.
    The items documented here are not actually in package builtin
    but their descriptions here allow godoc to present documentation
    for the language's special identifiers.
*/
package builtin

注意 ：

多行注释里不能再包含多行注释，比如下面的写法是错误的：

/* /* 我是多行注释 */ */