14.Go语言命名约定

使用gofmt

为了确保按要求的约定设置一Go代码的格式,Go提供了gofmt,这个工具的优点在于,让你甚至都无须了解代码格式设置约定,通过不断地学习如何设置代码格式,你自然而言地就会遵循代码格式设置约定

package main   ; import "fmt";
func main(){fmt.Println("hello,world")}

以上代码不会报错,但影响阅读

//终端命令
gofmt test.go   //将test.go文件重新布局,不会覆盖
gofmt -w test.go    //将test.go文件重新布局后覆盖

命名约定

  • 以大写字开头的标识符会被导出,而以小写字母开头的不会
  • 一般使用i表示整型,s表示字符串
  • 给变量命名一般使用驼峰命名法或帕斯卡拼写法
  • 接口名通常是:在动词后面加上后缀er,形成一个名词。后缀er通常表示操作

使用golint

golint是Go语言提供的一个官方工具,gofmt根据指定的约定设置代码的格式,而命令golint根据Go项目本身的预定查找风格方面的错误。默认不会安装golint,但可像下面这样进行安装

go get -u github.com/golang/lint/goint

要合适是否安装了这个工具,可在终端中执行命令golint-help

使用godoc

godoc是一款官方工具,可通过分析Go语言源代码及其中的注释来申城文档,由于文档是根据源代码生成的,这在很大程度上避免了文档不同步

go get golang.org/x/tools/cmd/godoc

只需要使用标准注释对代码进行注释,并遵守一些简单的约定节课,要给一段代码添加注释,只需在注释行开头指出要注释的元素的名称

© 版权声明
THE END
喜欢就支持以下吧
点赞0
分享
评论 抢沙发
四曲的头像-四曲博客

昵称

取消
昵称表情代码图片