这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
如何编写高质量的Go代码
要注意以下原则
我们可以借助gofmt自动格式化代码
gofmt
gofmt可以将go的源代码格式化成符合官方统一标准的风格，属于语法风格层面上的小型重构。 gofmt hello.go 仅打印代码格式化后的结果
-w 参数可以将执行的修改应用的源文件中。
gofmt -w filename
-r 参数可以对文件内容进行一些简单的替换
go -r <原始内容> -> <替换内容>
gofmt -r '(a) -> a' –w *.go
上面的代码会将源文件中没有意义的括号去掉
gofmt –r 'A.Func1(a,b) -> A.Func2(b,a)' –w *.go
上面的代码会将源文件中符合条件的函数的参数调换位置
编码规范：注释
go 的注释有行注释 // 和块注释 /* */ 之分。在实际的使用中，行注释使用得比较多，块注释主要用于格式化大段代码或包的注释中使用。
在 goland 中行注释的快捷键为 Ctrl+/, 块注释的快捷键为 Ctrl+Shift+/
注释的意义
- 注释可以帮我们很好的完成文档的工作，写得好的注释可以方便我们以后的维护。
- /**/ 的块注释和 // 的单行注释两种注释风格， 在我们的项目中为了风格的统一，全部使用单行注释，注释的质量决定了生成的文档的质量。
- 下面从包注释、结构体（接口）注释、函数（方法）注释、代码逻辑注释以及注释规范方面进行说明。
包注释
- 每个包都应该有一个包注释，一个位于 package 子句之前行注释
- 包注释应该包含下面基本信息
这是我对课程的一些浅显的理解。
