Goで日本語コメントを書く悩み - Qiita

この記事はGo2 Advent Calendar 15日目の記事です。 コメントの悩み まずは復習から。 とりあえず関数を例にします。Goでは関数などのシンボルの上に、 関数名[半角スペース]内容... という形式でコメントを書くことで、自動的に関数とコメントを紐付けてドキュメント化してくれます。複数行書くこともできます。 // Hoge reports whether the hoge is fuga. // hogehoge. hogehoge. func Hoge() {} ↓ 便利ですね。 問題は、このコメントを日本語で書くとき起こります。 社内で使うツールなどは、分かりやすさ優先でドキュメントは日本語にすることが多いかと思います。個人的にも、そうした方がベターだと考えます。 そういったときよく見かける（自分の観測範囲内）のがこんなコメント。