代码格式formatting

目的：规范代码的统一格式，做成语言内置的特性，相当于一个权威的代码格式规范，促进社区使用统一格式规范。

一些规范：

• 缩进（indentation）：默认使用tab
• 代码行的长度：无行长度限制，可以将一行分成多行，通过缩进来表示多选
• 花括号：相对于c与java，需要较少的花括号

注释 comment

类型：

• block comment: /* */

• line comment: //

• 注释只能使用纯文本，包含复杂语法，比如html，md之类的不支持。

• 注释以整个句子为一个单元，如果用逗号把一个句子分成多行，实际使用go doc查看的时候，是一行，查看时，根据宽度，自动换行显示

• 包级别的注释。注释时必须以注释的对象（比如函数，变量）为开关。例子：https://golang.org/pkg/regexp/#Compile
  ，解释Compile的注释，以Compile开头

names

package names

参考：https://www.jianshu.com/p/2c6c5b8610b3

Getters & Setters

• Getter: obj.Xxx()
• Setter: obj.SetXxx(xxx type)

interface name

• 如果该接口只有一个方法，加上"er"后缀作为结尾，
• 使用已经存在的的接口规范，如 Reader, Writer，使用Stringer而不自己定义ToString方法

有疑问加站长微信联系（非本文作者）