教程集 > Golang编程 > golang教程 > 正文 go 编程规范

go 编程规范

发布时间：2021-12-08 编辑：jiaochengji.com

教程集为您提供go 编程规范等资源，欢迎您收藏本站，我们将为您提供最新的go 编程规范资源

参考https://www.cnblogs.com/liang1101/p/7719762.html

Go 语言编程规范

<h3>1. gofmt 命令</h3>

　　大部分的格式问题可以通过 gofmt 来解决，gofmt 自动格式化代码，保证所有的 go 代码与官方推荐的格式保持一致，所有格式有关问题，都以gofmt的结果为准。所以，建议在提交代码库之前先运行一下这个命令。

　　一行最长不超过80个字符，超过的使用换行展示，尽量保持格式优雅。

　　在编码阶段应该同步写好变量、函数、包的注释，最后可以利用 godoc 命令导出文档。注释必须是完整的句子，句子的结尾应该用句号作为结尾（英文句号）。注释推荐用英文，可以在写代码过程中锻炼英文的阅读和书写能力。而且用英文不会出现各种编码的问题。

　　每个包都应该有一个包注释，一个位于 package 子句之前的块注释或行注释。包如果有多个 go 文件，只需要出现在一个 go 文件中即可。

<pre>　　// ping包实现了常用的ping相关的函数 　　package ping </pre>

<h3>4. 命名</h3> <ul><li>需要注释来补充的命名就不算是好命名。</li><li>使用可搜索的名称：单字母名称和数字常量很难从一大堆文字中搜索出来。单字母名称仅适用于短方法中的本地变量，名称长短应与其作用域相对应。若变量或常量可能在代码中多处使用，则应赋其以便于搜索的名称。</li><li>做有意义的区分：Product 和 ProductInfo 和 ProductData 没有区别，NameString 和 Name 没有区别，要区分名称，就要以读者能鉴别不同之处的方式来区分。</li><li>函数命名规则：驼峰式命名，名字可以长但是得把功能，必要的参数描述清楚，函数名应当是动词或动词短语，如 postPayment、deletePage、save。并依 Javabean 标准加上 get、set、is前缀。例如：xxx With 需要的参数名 And 需要的参数名 …..</li><li>结构体命名规则：结构体名应该是名词或名词短语，如 Custome、WikiPage、Account、AddressParser，避免使用 Manager、Processor、Data、Info、这样的类名，类名不应当是动词。</li><li>包名命名规则：包名应该为小写单词，不要使用下划线或者混合大小写。</li><li>接口命名规则：单个函数的接口名以”er”作为后缀，如 Reader,Writer。接口的实现则去掉“er”。</li></ul>

<pre>　　type Reader interface { Read(p []byte) (n int, err error) 　　} 　　// 多个函数接口 　　type WriteFlusher interface { 　　Write([]byte) (int, error) 　　Flush() error 　　}</pre>

　　常量均需使用全部大写字母组成，并使用下划线分词：

<pre>　　const APP_VER = "1.0"</pre>

　　如果是枚举类型的常量，需要先创建相应类型：

<pre>　　type Scheme string 　　const ( 　　 HTTP Scheme = "http" 　　HTTPS Scheme = "https" 　　)</pre>

　　变量命名基本上遵循相应的英文表达或简写，在相对简单的环境（对象数量少、针对性强）中，可以将一些名称由完整单词简写为单个字母，例如：

<ul><li><ul><li>user 可以简写为 u</li><li>userID 可以简写 uid</li><li>若变量类型为 bool 类型，则名称应以 Has, Is, Can 或 Allow 开头：</li></ul></li></ul>

<pre>　　var isExist bool 　　var hasConflict bool 　　var canManage bool 　　var allowGitHook bool</pre>

<h3>7. 变量命名惯例</h3>

　　变量名称一般遵循驼峰法，但遇到特有名词时，需要遵循以下规则：

<ul><li>如果变量为私有，且特有名词为首个单词，则使用小写，如：apiClient</li><li>其它情况都应当使用该名词原有的写法，如 APIClient、repoID、UserID</li><li>错误示例：UrlArray，应该写成 urlArray 或者 URLArray</li></ul>

　　下面列举了一些常见的特有名词：

<pre>　　"API"，"ASCII"，"CPU"，"CSS"，"DNS"，"EOF"，GUID"，"HTML"，"HTTP"，"HTTPS"，"ID","IP"，"JSON"，"LHS"，"QPS"，"RAM"，"RHS" 　　"RPC", "SLA"，"SMTP"，"SSH"，"TLS"，"TTL","UI"，"UID"，"UUID"，"URI"，"URL"， "UTF8"，"VM"，"XML"，"XSRF"，"XSS" </pre>

<h3>8. struct规范</h3>

　　struct申明和初始化格式采用多行，定义如下：

<pre>　　type User struct{ 　　Username string 　　Email string 　　}</pre>

　　初始化如下：

<pre>　　u := User{ 　　 Username: "test", 　　Email: "test@gmail.com", 　　}</pre>

<h3>9. panic</h3>

　　尽量不要使用panic，除非你知道你在做什么

<h3>10. import</h3>

　　对 import 的包进行分组管理，用换行符分割，而且标准库作为分组的第一组。如果你的包引入了三种类型的包，标准库包，程序内部包，第三方包，建议采用如下方式进行组织你的包

<pre>package main import ( "fmt" "os" "kmg/a" "kmg/b" "code.google.com/a" "github.com/b" )</pre>

　　goimports 会自动帮你格式化

<h3>11. 参数传递</h3> <ul><li>对于少量数据，不要传递指针</li><li>对于大量数据的 struct 可以考虑使用指针</li><li>传入的参数是 map，slice，chan 不要传递指针，因为 map，slice，chan 是引用类型，不需要传递指针的指针</li></ul><h3>12. 单元测试</h3>

　　单元测试文件名命名规范：

　　　　 example_test.go

　　测试用例的函数名称必须以 Test 开头，例如：

　　　　func TestExample

<blockquote class="layui-elem-quote" style="width: 100%;overflow:hidden"> 作者： sokril
链接： http://blog.csdn.net
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
</blockquote>

到此这篇关于“go 编程规范”的文章就介绍到这了,更多文章或继续浏览下面的相关文章，希望大家以后多多支持JQ教程网！

您可能感兴趣的文章：
Go 零基础编程入门教程
 Go语言学习3----Go语言特色
 go run main.go 参数_Go语言入门：Hello world
go比php好在哪里
 Effective Go
一分钟系列： Go 编程之用时定义
 Golang基础入门01 | 简介
 Golang学习笔记（五）：Go语言与C语言的区别
 Go语言的主要特性和发展影响
 GoImports安装使用（修正 go import包的规范）

上一篇：golang 的runtime机制下一篇：2018年最全Go语言教程零基础入门到进阶实战视频

[关闭]

浏览排行

~ ~

go 编程规范

最近更新

浏览排行