Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

このコミットは、Go言語の公式ドキュメントである doc/articles/slices_usage_and_internals.html における記述の修正です。具体的には、Goの配列(arrays)とスライス(slices)の要素へのアクセスが0から始まる(ゼロベースインデックスである)ことを明示的に追記し、ドキュメントの正確性と分かりやすさを向上させています。

コミット

commit f6dd45bf82f84454f5d461e8e88bd4e70c1dc614
Author: Andrew Gerrand <adg@golang.org>
Date:   Mon Jul 29 18:33:39 2013 +1000

    doc/articles: state that slices/arrays start at the 0th element
    
    Fixes #5881.
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/11892043

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

https://github.com/golang/go/commit/f6dd45bf82f84454f5d461e8e88bd4e70c1dc614

元コミット内容

このコミットの目的は、Go言語の公式ドキュメント doc/articles/slices_usage_and_internals.html にて、スライスおよび配列の要素が「0番目の要素から始まる」という事実を明記することです。これは、Goの配列やスライスがゼロベースインデックスであることを明確にするための修正であり、Fixes #5881 という記述から、関連するIssue(問題報告)を解決するための変更であることがわかります。https://golang.org/cl/11892043 は、この変更に対応するGerrit Code Reviewのチェンジリストへのリンクです。

変更の背景

この変更は、Go言語のIssue #5881 に対応するものです。Issue #5881は、Goの配列やスライスのインデックスがゼロベースであるという重要な情報が、slices_usage_and_internals.html ドキュメント内で明示的に述べられていないという指摘でした。プログラミング言語において、配列やコレクションのインデックスが0から始まるか1から始まるかは非常に重要な情報であり、これが不明確であると誤解やバグの原因となる可能性があります。このコミットは、ドキュメントの正確性を高め、Go言語の初心者を含む全てのユーザーが混乱なく配列やスライスを扱えるようにするために行われました。

前提知識の解説

Go言語の配列とスライス

Go言語には、固定長の「配列(Array)」と可変長の「スライス(Slice)」という2つの主要なシーケンス型があります。

  • 配列 (Array):

    • 要素の数が固定されており、宣言時にそのサイズが決定されます。
    • [N]Type の形式で宣言され、N は配列のサイズ、Type は要素の型を示します。
    • 例: var a [4]int は4つの整数を格納できる配列を宣言します。
    • 配列のサイズは型の一部であるため、[4]int[5]int は異なる型として扱われます。
  • スライス (Slice):

    • 配列の上に構築された、より強力で柔軟なデータ構造です。
    • 可変長であり、実行時に要素の数を増減させることができます。
    • []Type の形式で宣言されます。
    • スライスは、基となる配列の一部を参照する「ビュー」のようなものです。スライスは、その基底配列へのポインタ、長さ(len)、容量(cap)の3つの要素から構成されます。
    • Go言語でコレクションを扱う際には、ほとんどの場合スライスが使用されます。

ゼロベースインデックス

多くのプログラミング言語(C, C++, Java, Python, JavaScript, Goなど)では、配列やリスト、文字列などのシーケンス型における要素のインデックス(添字)は「0」から始まります。これを「ゼロベースインデックス」と呼びます。

  • 最初の要素はインデックス 0 でアクセスされます。
  • 2番目の要素はインデックス 1 でアクセスされます。
  • n 番目の要素はインデックス n-1 でアクセスされます。
  • 長さが L の配列やスライスの場合、有効なインデックスの範囲は 0 から L-1 までとなります。

このゼロベースインデックスの概念は、プログラミングの基本的な知識であり、特にGo言語の配列やスライスを扱う上で不可欠です。

技術的詳細

このコミットは、Go言語の公式ドキュメント doc/articles/slices_usage_and_internals.html の内容を修正するものです。このドキュメントは、Goのスライスと配列の基本的な使い方と内部構造について解説しています。

変更の具体的な内容は、配列の要素へのアクセス方法を説明する箇所に、インデックスが「ゼロから始まる」という情報を追記することです。

修正前の記述: the expression <code>s[n]</code> accesses the <i>n</i>th element: (式 s[n]n 番目の要素にアクセスします:)

修正後の記述: the expression <code>s[n]</code> accesses the <i>n</i>th element, starting from zero. (式 s[n]n 番目の要素にアクセスします。ゼロから始まります。)

この変更により、読者は s[0] が最初の要素であり、s[n]n+1 番目の要素(ゼロから数えて n 番目の要素)であることを明確に理解できるようになります。これは、特に他の言語で1ベースインデックスに慣れているプログラマーにとって、Goの動作を正しく理解するために重要な補足情報となります。

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

--- a/doc/articles/slices_usage_and_internals.html
+++ b/doc/articles/slices_usage_and_internals.html
@@ -25,7 +25,7 @@ the type <code>[4]int</code> represents an array of four integers. An array\'s
 size is fixed; its length is part of its type (<code>[4]int</code> and
 <code>[5]int</code> are distinct, incompatible types). Arrays can be indexed in
 the usual way, so the expression <code>s[n]</code> accesses the <i>n</i>th
-element:
+element, starting from zero.
 </p>
 
 <pre>

コアとなるコードの解説

上記のdiffは、doc/articles/slices_usage_and_internals.html ファイルに対する変更を示しています。

  • -element: の行は、変更前の元の行です。
  • +element, starting from zero. の行は、変更後の新しい行です。

この変更は、HTMLドキュメント内の <p> タグで囲まれた説明文の一部を修正しています。具体的には、<i>n</i>th element: という記述の後に , starting from zero. というフレーズが追加されています。

これにより、Goの配列やスライスにおいて s[n] という式で要素にアクセスする際に、そのインデックス n がゼロから始まる(つまり、s[0] が最初の要素である)という重要な情報が明示的に示されるようになりました。これは、ドキュメントの正確性と読者の理解を深めるための、非常にシンプルながらも効果的な修正です。

関連リンク

参考にした情報源リンク

  • Go言語公式ドキュメント: Slices: usage and internals (変更対象のドキュメント)
  • Go言語の配列とスライスに関する一般的な知識
  • ゼロベースインデックスに関する一般的なプログラミング知識
  • GitHubのコミット情報とdiff表示
  • Go Issue Tracker (Issue #5881)
  • Gerrit Code Review (CL 11892043)