Go言語入門：効果的なGo -Commentary-

ノウハウ

2025.06.02

この記事は約3分で読めます。

よっしー

こんにちは。よっしーです(^^)

本日は、Go言語を効果的に使うためのガイドラインについて解説しています。

背景
コメント
おわりに

背景

Go言語を学び始めて、より良いコードを書きたいと思い、Go言語の公式ドキュメント「Effective Go」を知りました。これは、いわば「Goらしいコードの書き方指南書」になります。単に動くコードではなく、効率的で保守性の高いコードを書くためのベストプラクティスが詰まっているので、これを読んだ時の内容を備忘として残しました。

Effective Go - The Go Programming Language

Goは、Cスタイルの/* */ブロックコメントとC++スタイルの//行コメントを提供しています。行コメントが標準的で、ブロックコメントは主にパッケージコメントとして使われますが、式の中で使用したり、大量のコードを無効化したりする場合にも有用です。

改行を挟まずにトップレベル宣言の前に現れるコメントは、その宣言自体をドキュメント化すると見なされます。これらの「docコメント」は、特定のGoパッケージやコマンドの主要なドキュメントとなります。docコメントの詳細については、「Go Doc Comments」を参照してください。

重要ポイント

2種類のコメント形式
- //：行コメント（推奨）
- /* */：ブロックコメント（特定の用途）
docコメントの特別な扱い
- トップレベル宣言の直前のコメントは自動的にドキュメントになる
- 改行を挟まないことが重要
用途の違い
- 行コメント：通常のコード説明
- ブロックコメント：パッケージ説明、複数行の無効化、式内コメント

実践例

// Package math provides basic mathematical constants and functions.
package math

// Pi is the ratio of a circle's circumference to its diameter.
const Pi = 3.14159265358979323846

/*
func oldFunction() {
    // この関数は現在使用されていません
    // 将来的に削除予定
}
*/

// Add returns the sum of a and b.
func Add(a, b int) int {
    return a + b /* inline comment */
}