Golang 编程规范

木猫尾巴 · · 141 次点击 · · 开始浏览    

[TOC]

介绍

golang 本身提供很多代码规范的工具,不用额外制定规范,毕竟文档不如工具扫描有时效性

go vet

go vet 是一个用于检查Go语言源码中静态错误的简单工具
go vet命令可以接受 -n 标记和 -x 标记

go tool vet

go tool vet 命令的作用是检查Go语言源代码并且报告可疑的代码编写问题

比如,在调用Printf函数时没有传入格式化字符串,以及某些不标准的方法签名,等等

该命令使用试探性的手法检查错误,因此并不能保证报告的问题确实需要解决。它确实能够找到一些编译器没有捕捉到的错误。

go tool vet命令的标记

-all    进行全部检查。如果有其他检查标记被设置,则命令程序会将此值变为false。默认值为true。
-asmdecl    对汇编语言的源码文件进行检查。默认值为false。
-assign    检查赋值语句。默认值为false。
-atomic    检查代码中对代码包sync/atomic的使用是否正确。默认值为false。
-buildtags    检查编译标签的有效性。默认值为false。
-composites    检查复合结构实例的初始化代码。默认值为false。
-compositeWhiteList    是否使用复合结构检查的白名单。仅供测试使用。默认值为true。
-methods    检查那些拥有标准命名的方法的签名。默认值为false。
-printf    检查代码中对打印函数的使用是否正确。默认值为false。
-printfuncs    需要检查的代码中使用的打印函数的名称的列表,多个函数名称之间用英文半角逗号分隔。默认值为空字符串。
-rangeloops    检查代码中对在```range```语句块中迭代赋值的变量的使用是否正确。默认值为false。
-structtags    检查结构体类型的字段的标签的格式是否标准。默认值为false。
-unreachable    查找并报告不可到达的代码。默认值为false。

more info see go 命令教程

race condition 检查

资源竞争检查,并发时遇到的问题,会导致并发能力下降, 长时间运行一般会出现这个错误

panic: runtime error: invalid memory address or nil pointer dereference
  • 检查方法
go build -race

文档见 http://blog.golang.org/race-detector

golint

安装方法

go get -v github.com/golang/lint
go install github.com/golang/lint

使用

golint [dir or file]

风格检查样例 https://github.com/golang/lint/tree/master/testdata

golint 检查范围就非常广了,也很严格,可以配合 vscode 的go 插件,或者 goland 来检查代码风格

本文来自:简书

感谢作者:木猫尾巴

查看原文:Golang 编程规范

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