golang语言的编码规范有哪些 - 行业资讯 - 肥雀云

　　介绍

本篇文章为大家展示了golang语言的编码规范有哪些,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。

<强>一,命名规范

命名是代码规范中很重要的一部分,统一的命名规则有利于提高的代码的可读性,好的命名仅仅通过命名就可以获取到足够多的信息。

在命名时以字母a到Z或a到Z或下划线开的头,后面跟着零或更多的字母,下划线和数字(0到9).Go不允许在命名时中使用@,美元和%等标点符号.Go是一种区分大小写的编程语言。因此,人力资源和人力资源是两个不同的命名。

当命名(包括常量,变量,类型,函数名,结构字段等等)以一个大写字母开头,如:Group1,那么使用这种形式的标识符的对象就可以被外部包的代码所使用(客户端程序需要先导入这个包),这被称为导出(像面向对象语言中的公众);
命名如果以小写字母开头,则对包外是不可见的,但是他们在整个包的内部是可见并且可用的(像面向对象语言中的私有)

<强> 1,包命名:包

保持包的名字和目录保持一致,尽量采取有意义的包名,简短,有意义,尽量和标准库不要冲突。包名应该为小写单词,不要使用下划线或者混合大小写。

package 演示　　package 主要

<强> 2,文件命名

尽量采取有意义的文件名,简短,有意义,应该为小写单词,使用下划线分隔各个单词。

my_test。以前去

<强> 3,结构体命名

采用驼峰命名法,首字母根据访问控制大写或者小写
struct申明和初始化格式采用多行,例如下面:

//,多行申明　　type User 结构{ 　　Username 才能;字符串　　,,Email 字符串　　}//,多行初始化　　用户{u :=, 　　用户名:,才能“astaxie", 　　电子邮件:,,才能“astaxie@gmail.com",, 　　}

<强> 4,接口命名

命名规则基本和上面的结构体类型
单个函数的结构名以“呃”作为后缀,例如读者,作家。

type Reader interface { 　　,,,(阅读p []字节),(n , int, err 错误) 　　}

<强> 5,变量命名

和结构体类似,变量名称一般遵循驼峰法,首字母根据访问控制原则大写或者小写,但遇到特有名词时,需要遵循以下规则:

<李>

如果变量为私有,且特有名词为首个单词,则使用小写,如apiClient

<李>

其它情况都应当使用该名词原有的写法,如apiClient, repoID, UserID

<李>

错误示例:UrlArray,应该写成UrlArray或者UrlArray

若变量类型为bool类型,则名称应以,,或允许开头

var isExist 保龄球　　var hasConflict 保龄球　　var canManage 保龄球　　var allowGitHook bool

<强> 6,常量命名

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

const APP_VER =,“1.0“

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

type Scheme 字符串　　　　const ( 　　HTTP 才能;Scheme =,“http" 　　HTTPS 才能;Scheme =,“https" 　　)

<强> 7,关键字

下面的列表显示了中去的保留字。这些保留字不能用作常量或变量或任何其他标识符名称。

golang语言的编码规范有哪些

<强>二、注释

去提供C风格的/* */块注释和c++风格的//行注释。行注释是常态;块注释主要显示为包注释,但在表达式中很有用或禁用大量代码。

<李>

单行注释是最常见的注释形式,你可以在任何地方使用以//开头的单行注释

<李>

多行注释也叫块注释,均已以/*开的头,并以*/结尾,且不可以嵌套使用,多行注释一般用于包的文档描述或注释成块的代码片段

去语言自带的godoc工具可以根据注释生成文档,生成可以自动生成对应的网站(golang.org就是使用godoc工具直接生成的),注释的质量决定了生成的文档的质量。每个包都应该有一个包注释,在包的子句之前有一个块注释。对于多文件包,包注释只需要存在于一个文件中,任何一个都可以。包评论应该介绍包,并提供与整个包相关的信息。它将首先出现在godoc页面上,并应设置下面的详细文档。