【Go】Golint代码规范检测

一. Golint介绍

Golint is a linter for Go source code.

1. Golint 是一个源码检测工具用于检测代码规范
2. Golint 不同于gofmt, Gofmt用于代码格式化

Golint会对代码做以下几个方面检查

1. package注释 必须按照 “Package xxx 开头”
2. package命名 不能有大写字母、下划线等特殊字符
3. struct、interface等注释 必须按照指定格式开头
4. struct、interface等命名
5. 变量注释、命名
6. 函数注释、命名
7. 各种语法规范校验等

二. Golint安装

1. go get -u github.com/golang/lint/golint
2. ls $GOPATH/bin (可以发现已经有golint可执行文件)

三. Golint使用

golint检测代码有2种方式

1. golint file
2. golint directory

golint校验常见的问题如下所示

1. don't use ALL_CAPS in Go names; use CamelCase
   不能使用下划线命名法，使用驼峰命名法
2. exported function Xxx should have comment or be unexported
   外部可见程序结构体、变量、函数都需要注释
3. var statJsonByte shoul