Skip to Content

golintよくあるエラー集

概要

golintにすぐ怒られるので解決策のメモ

typeシリーズ

タイプ名にコメントがない

exported type [type名] should have comment or be unexported

type を宣言した上の行にtype名 コメントの形で残す
type名の後に半角スペースが必要

NGパターン

type Universe [][]bool // 世界を表すUniverse型を定義

OKパターン

// Universe は2次元配列で世界を表現する
type Universe [][]bool

タイプ名のコメント書式が誤っている

comment on exported type [type名] should be of the form "[type名] ..." (with optional leading article)

type を宣言した上の行にtype名 コメントの形で残す
type名の後に半角スペースが必要

NGパターン

// 世界を表すUniverse型を定義
type Universe [][]bool

OKパターン

// Universe は2次元配列で世界を表現する
type Universe [][]bool

functionシリーズ

関数にコメントがない

exported function [function名] should have comment or be unexported

func を宣言した上の行にfunc名 コメントの形で残す
function名の後に半角スペースが必要

NGパターン

func NewUniverse() Universe {

OKパターン

// NewUniverse は指定のグリッドサイズで2次元配列を作成・初期化
func NewUniverse() Universe 

関数のコメント書式が誤っている

comment on exported function [function名] should be of the form "[function名] ..."

func を宣言した上の行にfunc名 コメントの形で残す
function名の後に半角スペースが必要

NGパターン

// 指定のグリッドサイズで2次元配列を作成・初期化
func NewUniverse() Universe {

OKパターン

// NewUniverse は指定のグリッドサイズで2次元配列を作成・初期化
func NewUniverse() Universe 

参考

https://blog.haramishio.xyz/entry/learn-with-golint#type%E3%81%AB%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88%E3%81%8C%E3%81%A4%E3%81%84%E3%81%A6%E3%81%84%E3%82%8B%E3%81%8B