[インデックス 17387] ファイルの概要

このコミットは、Go言語の標準ライブラリ bytes パッケージ内の Equal 関数のドキュメントを明確にするための変更です。具体的には、Go言語においてスライス型に == 演算子が定義されていないという重要な特性を考慮し、誤解を招く可能性のある記述を修正しています。

コミット

• コミットハッシュ: 9ec0f30a25dc2f2b106a30130bf6b97d2d20ef3f
• 作者: Brad Fitzpatrick bradfitz@golang.org
• コミット日時: 2013年8月24日 土曜日 17:05:27 -0500
• コミットメッセージ:

  bytes: clarify Equal docs
  
  == isn't defined on slices, so don't use it in docs.
  
  R=golang-dev, iant
  CC=golang-dev
  https://golang.org/cl/12983045
  

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/9ec0f30a25dc2f2b106a30130bf6b97d2d20ef3f

元コミット内容

bytes: clarify Equal docs

== isn't defined on slices, so don't use it in docs.

R=golang-dev, iant
CC=golang-dev
https://golang.org/cl/12983045

変更の背景

Go言語では、スライス（[]byteのような型）は参照型であり、その比較に == 演算子を使用することはできません。== 演算子は、配列や構造体、ポインタ、チャネル、インターフェース、マップ、関数などの特定の型に対してのみ定義されています。スライスの場合、== 演算子で比較できるのは nil とのスライスのみです。異なる2つのスライスが同じ要素を持っているかどうかを比較するには、要素を一つずつ比較するか、bytes.Equal のような専用の関数を使用する必要があります。

このコミット以前の bytes.Equal 関数のドキュメントには、「Equal returns a boolean reporting whether a == b.」という記述がありました。この記述は、Go言語のスライスの比較に関する基本的なルールを知らない開発者に対して、「スライスは == で比較できる」という誤解を与える可能性がありました。

この変更の背景には、Go言語の設計思想である「明確さ」と「誤解の排除」があります。ドキュメントはコードの振る舞いを正確に反映し、ユーザーが混乱するような表現は避けるべきです。したがって、スライスに == 演算子が定義されていないという事実を明確にするため、ドキュメントの記述が修正されました。

前提知識の解説

Go言語のスライス

Go言語のスライスは、配列をラップした動的なビューです。スライスは、内部的に以下の3つの要素で構成されます。

1. ポインタ: スライスが参照する基底配列の先頭要素へのポインタ。
2. 長さ (Length): スライスに含まれる要素の数。
3. 容量 (Capacity): スライスのポインタから基底配列の末尾までの要素の数。

スライスは参照型であるため、変数を別のスライス変数に代入すると、同じ基底配列を共有する新しいスライスヘッダが作成されます。

Go言語における == 演算子の振る舞い

Go言語では、== 演算子は型によって異なる振る舞いをします。

• 数値型、文字列型、ブール型: 値の等価性を比較します。
• ポインタ型: ポインタが同じメモリ位置を指しているかどうかを比較します。
• チャネル型: 同じチャネル値を参照しているかどうかを比較します。
• インターフェース型: 動的な型と動的な値が両方とも等しいかどうかを比較します。
• 構造体型: すべてのフィールドが再帰的に等しいかどうかを比較します。
• 配列型: すべての要素が再帰的に等しいかどうかを比較します。
• マップ型、関数型、スライス型: これらの型は == 演算子で直接比較することはできません（nil との比較を除く）。マップと関数は参照型であり、スライスも参照型であるため、== で比較すると、それらが同じメモリ位置を指しているかどうかではなく、値の等価性を比較しようとすることになり、これはGoの設計上許可されていません。

bytes.Equal 関数

bytes.Equal 関数は、2つのバイトスライス a と b が同じ長さで、かつ同じバイトシーケンスを含んでいる場合に true を返します。これは、バイトスライスの内容を比較するためのGo言語の標準的な方法です。

技術的詳細

Go言語の型システムにおいて、スライスは == 演算子による直接的な値の比較をサポートしていません。これは、スライスが基底配列へのポインタ、長さ、容量という3つの要素から構成されるためです。もし == がスライスに対して定義された場合、それはポインタの比較（つまり、同じ基底配列の同じ部分を指しているか）を意味するのか、それとも内容の比較（つまり、すべての要素が同じか）を意味するのか、曖昧になります。Go言語の設計者は、この曖昧さを避けるために、スライスに対する == 演算子の使用を禁止し、内容の比較には bytes.Equal のような専用の関数を使用することを推奨しています。

このコミットは、このGo言語の重要な特性を bytes.Equal 関数のドキュメントに正確に反映させることを目的としています。以前のドキュメントの「Equal returns a boolean reporting whether a == b.」という記述は、あたかもスライスが == 演算子で内容比較できるかのように誤解させる可能性がありました。これは、特にGo言語を学び始めたばかりの開発者にとって混乱の原因となり得ます。

修正後のドキュメント「Equal returns a boolean reporting whether a and b are the same length and contain the same bytes.」は、bytes.Equal が実際に何を行っているのか（長さと内容の比較）を明確に記述しており、スライスに対する == 演算子の制限に関する誤解を完全に排除しています。この変更は、Go言語のドキュメントの品質と正確性を向上させるための小さな、しかし重要な改善です。

コアとなるコードの変更箇所

変更は src/pkg/bytes/bytes_decl.go ファイルの Equal 関数のドキュメントコメントに対して行われました。

--- a/src/pkg/bytes/bytes_decl.go
+++ b/src/pkg/bytes/bytes_decl.go
@@ -11,7 +11,8 @@ func IndexByte(s []byte, c byte) int // ../runtime/asm_$GOARCH.s
 
 //go:noescape
 
-// Equal returns a boolean reporting whether a == b.
+// Equal returns a boolean reporting whether a and b
+// are the same length and contain the same bytes.
 // A nil argument is equivalent to an empty slice.
 func Equal(a, b []byte) bool // ../runtime/asm_$GOARCH.s
 

コアとなるコードの解説

変更されたのは、bytes.Equal 関数の宣言の直前にあるコメント行です。

• 変更前:

  // Equal returns a boolean reporting whether a == b.
  

  この行は、Equal 関数が a == b の結果を返すかのように示唆していました。しかし、前述の通り、Go言語ではスライスに対して == 演算子による内容比較は定義されていません。

• 変更後:

  // Equal returns a boolean reporting whether a and b
  // are the same length and contain the same bytes.
  

  この新しい記述は、Equal 関数が実際に実行する比較のロジックを正確に説明しています。すなわち、2つのバイトスライス a と b の「長さが同じであること」と「含まれるバイトが同じであること」の両方を満たす場合に true を返す、というものです。これにより、Go言語のスライスの比較に関する誤解が解消され、ドキュメントの正確性が向上しました。

この変更は、コードの機能自体には影響を与えず、あくまでドキュメントの記述を改善するものです。しかし、Go言語の設計原則である「明確さ」と「正確性」を反映した重要な修正と言えます。

関連リンク

• Go CL 12983045: https://golang.org/cl/12983045

参考にした情報源リンク

• Go言語の公式ドキュメント (bytesパッケージ): https://pkg.go.dev/bytes
• Go言語の仕様 (Comparison operators): https://go.dev/ref/spec#Comparison_operators
• Go言語のスライスに関するブログ記事やチュートリアル (一般的な知識として)