Golang命名规范和开发规范

2023-11-18 11:30| 来源: 网络整理| 查看: 265

Golang命名规范和开发规范 rectinajh · · 9594 次点击 · · 开始浏览这是一个创建于的文章，其中的信息可能已经有所发展或是发生改变。第一次，站长亲自招 Gopher 了>>>

----目录----

命名文件命名 package 变量常量接口结构体方法注释 README 命名文件命名

文件命名一律采用小写，不用驼峰式，尽量见名思义，看见文件名就可以知道这个文件下的大概内容。其中测试文件以test.go结尾，除测试文件外，命名不出现。

例子：

stringutil.go， stringutil_test.go

包名package

包名用小写,使用短命名,尽量和标准库不要冲突。包名统一使用单数形式。

变量

变量命名一般采用驼峰式，当遇到特有名词（缩写或简称，如DNS）的时候，特有名词根据是否私有全部大写或小写。

例子：

apiClient、URLString

常量

同变量规则，力求语义表达完整清楚，不要嫌名字长。如果模块复杂，为避免混淆，可按功能统一定义在package下的一个文件中。

接口

单个函数的接口名以 er 为后缀

type Reader interface { Read(p []byte) (n int, err error) }

两个函数的接口名综合两个函数名，如:

type WriteFlusher interface { Write([]byte) (int, error) Flush() error }

三个以上函数的接口名类似于结构体名，如:

type Car interface { Start() Stop() Drive() } 结构体

结构体名应该是名词或名词短语，如Account,Book，避免使用Manager这样的。如果该数据结构需要序列化，如json，则首字母大写，包括里面的字段。

方法

方法名应该是动词或动词短语，采用驼峰式。将功能及必要的参数体现在名字中，不要嫌长，如updateById，getUserInfo.

如果是结构体方法，那么 Receiver 的名称应该缩写，一般使用一个或者两个字符作为 Receiver 的名称。如果 Receiver 是指针，那么统一使用p。如：

func (f foo) method() { ... } func (p *foo) method() { ... }

对于Receiver命名应该统一，要么都使用值，要么都用指针。

注释

每个包都应该有一个包注释，位于 package 之前。如果同一个包有多个文件，只需要在一个文件中编写即可；如果你想在每个文件中的头部加上注释，需要在版权注释和 Package前面加一个空行，否则版权注释会作为Package的注释。如：

每个以大写字母开头（即可以导出）的方法应该有注释，且以该函数名开头。如：

// Get 会响应对应路由转发过来的 get 请求 func (c *Controller) Get() { ... }

大写字母开头的方法以为着是可供调用的公共方法，如果你的方法想只在本包内掉用，请以小写字母开发。如:

func (c *Controller) curl() { ... }

注释应该用一个完整的句子，注释的第一个单词应该是要注释的指示符，以便在 godoc 中容易查找。

注释应该以一个句点 . 结束。

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

本文来自：简书

感谢作者：rectinajh

查看原文：Golang命名规范和开发规范

入群交流（和以上内容无关）：加入Go大咖交流群，或添加微信：liuxiaoyan-s 备注：入群；或加QQ群：692541889

9594 次点击加入收藏微博赞

【本文地址】

公司简介

联系我们