effective go

cdz620 · · 2455 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

代码格式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方法

有疑问加站长微信联系(非本文作者)

本文来自:简书

感谢作者:cdz620

查看原文:effective go

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

2455 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传