这是我参与「第五届青训营 」伴学笔记创作活动的第 11 天
- 编码规范-注释
- 首先是注释应该解释代码作用，这种注释适合说明公共符号，比如对外提供的函数注释描述它的功能和用途. 只有在函数的功能简单而明显时才能省略这些注释(例如, 简单的取值和设值函数) 另外注释要避免啰嗦, 不要对显而易见的内容进行说明. 下面的代码中注释就没有必要加上，通过名称可以很容易的知道作用 备注：后续的内容有不少代码，大部分是从go的仓库中摘录出来的，下方就是代码链接，感兴趣的可以看看相关的文件
- 第二种注释是对代码中复杂的，并不明显的逻辑进行说明，适合注释实现过程 上面这段代码是给新url加上最近的referer信息，并不是特别明显，所以注释说明了一下 下面的是一个反例，虽然是对过程注释，但是描述的是显而易见的流程，注意不要用自然语言直接翻译代码作为注释，信息冗余还好，有时候表述不一定和代码一致
- 第三条，注释可以解释代码的外部因素，这些因素脱离上下文后通常很难理解 示例中有一行shouldRedirect=false的语句，如果没有注释，无法清楚地明白为什么会设置 false 所以注释里提到了这么做的原因，给出了上下文说明
- 第四，注释应该提醒使用者一些潜在的限制条件或者会无法处理的情况 例如函数的注释中可以说明是否存在性能隐患，输入的限制条件，可能存在哪些错误情况，让使用者无需了解实现细节 示例介绍了解析时区字符串的流程，同时对可能遇到的不规范字符串处理进行了说明
