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

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

このコミットは、Go言語の公式ドキュメントの一部であるdoc/codewalk/markov.xmlファイルを変更しています。このファイルは、Goのコードウォーク（codewalk）システムで使用されるXML形式の定義ファイルであり、特定のGoソースコードのセクションをハイライト表示するための情報を含んでいます。具体的には、markov.goというファイル内のコードスニペットを、ステップバイステップで解説する際にどの範囲を強調表示するかを定義しています。

コミット

  • コミットハッシュ: c5ebeff3aacb6a9f2460d4bc90a50ab6deb926ec
  • 作者: Oling Cat olingcat@gmail.com
  • コミット日時: 2012年10月18日 木曜日 08:12:44 +1100

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

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

元コミット内容

doc/codewalk/markov: fix the highlight range of the step "The NewChain constructor function".

R=r, minux.ma, adg
CC=golang-dev
https://golang.org/cl/6710044

変更の背景

このコミットの目的は、Goのコードウォーク「Markov」における「The NewChain constructor function」というステップのハイライト表示範囲を修正することです。コードウォークは、Goのコードベースをステップごとに解説するためのインタラクティブなチュートリアルシステムです。特定のコードスニペットを読者に提示し、その部分に焦点を当てて説明するために、XMLファイル内でハイライト範囲が定義されています。

以前の定義では、NewChainコンストラクタ関数のハイライト範囲が正しく設定されておらず、おそらく関数の末尾が適切に強調表示されていなかったと考えられます。この修正は、ユーザーがコードウォークを体験する際に、意図した通りのコード範囲が正確にハイライトされるようにするために行われました。これにより、学習体験の質が向上し、誤解を防ぐことができます。

前提知識の解説

Go Code Walk (コードウォーク)

Go Code Walkは、Go言語の公式ウェブサイトで提供されているインタラクティブなチュートリアルシステムです。Goのコードベースをステップバイステップで解説し、読者が実際にコードを読みながら学習できるように設計されています。各ステップでは、特定のコードスニペットが提示され、そのコードの機能や概念が説明されます。このシステムは、Go言語の学習者にとって非常に有用なリソースとなっています。

コードウォークは、Goのソースコードと、そのコードのどの部分をどのステップでハイライトするかを定義するXMLファイル（例: markov.xml）で構成されます。XMLファイル内の<step>要素は、各チュートリアルステップを定義し、src属性を使用してハイライトするソースコードのファイルパスと範囲を指定します。

正規表現 (Regular Expression)

正規表現は、文字列のパターンを記述するための強力なツールです。このコミットでは、XMLのsrc属性内で正規表現が使用されています。src属性の形式は通常、ファイルパス:/開始パターン/,/終了パターン/のようになります。ここで、/開始パターン/と/終了パターン/は、ソースファイル内でハイライトを開始および終了する位置を特定するための正規表現です。

  • / (スラッシュ): 正規表現のリテラルを囲むデリミタとして使用されます。
  • func New: 文字列「func New」にマッチします。これはGoの関数定義の開始部分によく見られます。
  • } (閉じ波括弧): 文字「}`」にマッチします。これはGoのブロックや関数の終了を示すためによく使われます。
  • \n (改行文字): 改行文字にマッチします。
  • \ (バックスラッシュ): 正規表現において、特殊文字をエスケープするために使用されます。例えば、}は正規表現の特殊文字ではないためエスケープは必須ではありませんが、\を前置することでリテラルな}として解釈されることをより明確にできます。しかし、この変更の文脈では、\nと組み合わせることで、改行の直後にある}にマッチさせる意図があります。

技術的詳細

このコミットの核心的な変更は、doc/codewalk/markov.xmlファイル内の<step>要素のsrc属性の正規表現の修正です。

変更前:

<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/}/">

変更後:

<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/\\n}/">

この変更は、ハイライト範囲の終了を示す正規表現を/}/から/\\n}/に変更しています。

  • /}/: これは、func Newという文字列が見つかった位置から、次に現れる}（閉じ波括弧）までの範囲をハイライトするように指示していました。しかし、Goのコードでは、関数の閉じ波括弧が単独で一行を占めることがよくあります。もし、関数の本体内に別のブロックの閉じ波括弧が存在する場合、意図しない場所でハイライトが終了してしまう可能性がありました。

  • /\\n}/: この新しい正規表現は、func Newという文字列が見つかった位置から、**改行文字 (\n) の直後に続く }（閉じ波括弧）**までの範囲をハイライトするように指示しています。

    • \\nは、XML属性内でバックスラッシュをエスケープするために二重に記述されています。実際の正規表現としては\nとして解釈されます。
    • このパターンは、通常、関数の定義の最後の行にある閉じ波括弧に正確にマッチすることを意図しています。これにより、関数の本体全体が適切にハイライトされ、途中でハイライトが途切れることがなくなります。

この修正により、「The NewChain constructor function」ステップのハイライトが、NewChain関数の定義全体を正確にカバーするようになり、コードウォークの読者がより正確な情報を得られるようになりました。

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

--- a/doc/codewalk/markov.xml
+++ b/doc/codewalk/markov.xml
@@ -58,7 +58,7 @@ Prefix               Map key
 	this data.
 </step>

-<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/}/">
+<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/\\n}/">
 	The <code>Chain</code> struct has two unexported fields (those that
 	do not begin with an upper case character), and so we write a
 	<code>NewChain</code> constructor function that initializes the

コアとなるコードの解説

上記の差分は、doc/codewalk/markov.xmlファイルの59行目における変更を示しています。

変更前は、<step>タグのsrc属性がdoc/codewalk/markov.go:/func New/,/}/となっていました。これは、markov.goファイル内で「func New」という文字列から始まり、次に現れる「}」で終わる範囲をハイライトするという意味です。

変更後は、src属性がdoc/codewalk/markov.go:/func New/,/\\n}/に変更されています。この変更のポイントは、終了の正規表現が/}/から/\\n}/になった点です。

  • \nは改行文字を表します。
  • \\はXML属性内でバックスラッシュをエスケープするために使用されるため、正規表現エンジンには単一のバックスラッシュとして渡されます。したがって、正規表現としては\n}となります。

この\n}という正規表現は、「改行の直後に続く閉じ波括弧」にマッチします。Go言語のコーディングスタイルでは、関数の最後の閉じ波括弧は通常、単独の行に配置されます。したがって、この変更により、NewChainコンストラクタ関数の定義全体（関数の開始から、その関数の最後の閉じ波括弧まで）が正確にハイライトされるようになります。

これにより、コードウォークのユーザーは、NewChain関数の完全な実装を視覚的に把握できるようになり、チュートリアルの意図がより明確に伝わるようになりました。

関連リンク

参考にした情報源リンク

  • Go Code Walkの概念に関する一般的な情報 (Web検索結果に基づく)
  • 正規表現の基本的な構文に関する情報 (Web検索結果に基づく)
  • XML属性内での特殊文字のエスケープに関する情報 (Web検索結果に基づく)
  • Go言語のコーディングスタイルに関する一般的な情報 (Web検索結果に基づく)

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

このコミットは、Go言語の公式ドキュメントの一部であるdoc/codewalk/markov.xmlファイルを変更しています。このファイルは、Goのコードウォーク（codewalk）システムで使用されるXML形式の定義ファイルであり、特定のGoソースコードのセクションをハイライト表示するための情報を含んでいます。具体的には、markov.goというファイル内のコードスニペットを、ステップバイステップで解説する際にどの範囲を強調表示するかを定義しています。

コミット

  • コミットハッシュ: c5ebeff3aacb6a9f2460d4bc90a50ab6deb926ec
  • 作者: Oling Cat olingcat@gmail.com
  • コミット日時: 2012年10月18日 木曜日 08:12:44 +1100

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

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

元コミット内容

doc/codewalk/markov: fix the highlight range of the step "The NewChain constructor function".

R=r, minux.ma, adg
CC=golang-dev
https://golang.org/cl/6710044

変更の背景

このコミットの目的は、Goのコードウォーク「Markov」における「The NewChain constructor function」というステップのハイライト表示範囲を修正することです。コードウォークは、Goのコードベースをステップごとに解説するためのインタラクティブなチュートリアルシステムです。特定のコードスニペットを読者に提示し、その部分に焦点を当てて説明するために、XMLファイル内でハイライト範囲が定義されています。

以前の定義では、NewChainコンストラクタ関数のハイライト範囲が正しく設定されておらず、おそらく関数の末尾が適切に強調表示されていなかったと考えられます。Go言語のコーディング規約では、関数の閉じ波括弧は通常、単独の行に配置されます。しかし、従来の正規表現/}/では、関数の本体内に存在する他のブロック（例えばif文やforループ）の閉じ波括弧に誤ってマッチしてしまい、意図したよりも早くハイライトが終了してしまう可能性がありました。

この修正は、ユーザーがコードウォークを体験する際に、意図した通りのコード範囲が正確にハイライトされるようにするために行われました。これにより、学習体験の質が向上し、誤解を防ぐことができます。

前提知識の解説

Go Code Walk (コードウォーク)

Go Code Walkは、Go言語の公式ウェブサイトで提供されているインタラクティブなチュートリアルシステムです。Goのコードベースをステップバイステップで解説し、読者が実際にコードを読みながら学習できるように設計されています。各ステップでは、特定のコードスニペットが提示され、そのコードの機能や概念が説明されます。このシステムは、Go言語の学習者にとって非常に有用なリソースとなっています。

コードウォークは、Goのソースコードと、そのコードのどの部分をどのステップでハイライトするかを定義するXMLファイル（例: markov.xml）で構成されます。XMLファイル内の<step>要素は、各チュートリアルステップを定義し、src属性を使用してハイライトするソースコードのファイルパスと範囲を指定します。src属性の形式は通常、ファイルパス:/開始パターン/,/終了パターン/のようになります。ここで、/開始パターン/と/終了パターン/は、ソースファイル内でハイライトを開始および終了する位置を特定するための正規表現です。

正規表現 (Regular Expression)

正規表現は、文字列のパターンを記述するための強力なツールです。このコミットでは、XMLのsrc属性内で正規表現が使用されています。

  • / (スラッシュ): 正規表現のリテラルを囲むデリミタとして使用されます。
  • func New: 文字列「func New」にリテラルにマッチします。これはGoの関数定義の開始部分によく見られます。
  • } (閉じ波括弧): 文字「}`」にリテラルにマッチします。これはGoのブロックや関数の終了を示すためによく使われます。
  • \n (改行文字): 改行文字にマッチします。正規表現において、\nは特定の改行コード（LF: Line Feed）を表します。
  • \ (バックスラッシュ): 正規表現において、特殊文字をエスケープするために使用されます。例えば、\nのように、バックスラッシュの後に続く文字が特別な意味を持つことを示します。XML属性内では、バックスラッシュ自体もエスケープが必要なため、\\と二重に記述されることがあります。これにより、XMLパーサーが\\を単一の\として解釈し、その結果、正規表現エンジンには\nとして渡されます。

技術的詳細

このコミットの核心的な変更は、doc/codewalk/markov.xmlファイル内の<step>要素のsrc属性の正規表現の修正です。

変更前:

<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/}/">

変更後:

<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/\\n}/">

この変更は、ハイライト範囲の終了を示す正規表現を/}/から/\\n}/に変更しています。

  • 変更前の/}/: これは、func Newという文字列が見つかった位置から、次に現れる}（閉じ波括弧）までの範囲をハイライトするように指示していました。しかし、Goのコードでは、関数の閉じ波括弧が単独で一行を占めることがよくあります。もし、関数の本体内に別のブロックの閉じ波括弧が存在する場合、意図しない場所でハイライトが終了してしまう可能性がありました。例えば、関数内にif文やforループがあり、それらが閉じ波括弧で終わる場合、その閉じ波括弧が先にマッチしてしまい、関数の残りの部分がハイライトされないという問題が発生します。

  • 変更後の/\\n}/: この新しい正規表現は、func Newという文字列が見つかった位置から、**改行文字 (\n) の直後に続く }（閉じ波括弧）**までの範囲をハイライトするように指示しています。

    • \\nは、XML属性内でバックスラッシュをエスケープするために二重に記述されています。実際の正規表現としては\nとして解釈されます。
    • このパターンは、通常、Go言語のコーディングスタイルにおいて関数の定義の最後の行にある閉じ波括弧に正確にマッチすることを意図しています。Goの関数定義の慣習では、関数の本体の最後の閉じ波括弧は通常、その前の行のコードとは独立して新しい行に配置されます。したがって、\n}というパターンは、関数の本体の終わりを示す閉じ波括弧に確実にマッチし、関数の本体全体が適切にハイライトされることを保証します。

この修正により、「The NewChain constructor function」ステップのハイライトが、NewChain関数の定義全体を正確にカバーするようになり、コードウォークの読者がより正確な情報を得られるようになりました。これは、コードウォークの教育的価値を高め、学習者がGoのコード構造をより正確に理解するのに役立ちます。

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

--- a/doc/codewalk/markov.xml
+++ b/doc/codewalk/markov.xml
@@ -58,7 +58,7 @@ Prefix               Map key
 	this data.
 </step>

-<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/}/">
+<step title="The NewChain constructor function" src="doc/codewalk/markov.go:/func New/,/\\n}/">
 	The <code>Chain</code> struct has two unexported fields (those that
 	do not begin with an upper case character), and so we write a
 	<code>NewChain</code> constructor function that initializes the

コアとなるコードの解説

上記の差分は、doc/codewalk/markov.xmlファイルの59行目における変更を示しています。

変更前は、<step>タグのsrc属性がdoc/codewalk/markov.go:/func New/,/}/となっていました。これは、markov.goファイル内で「func New」という文字列から始まり、次に現れる「}」で終わる範囲をハイライトするという意味です。

変更後は、src属性がdoc/codewalk/markov.go:/func New/,/\\n}/に変更されています。この変更のポイントは、終了の正規表現が/}/から/\\n}/になった点です。

  • \nは改行文字を表します。
  • \\はXML属性内でバックスラッシュをエスケープするために使用されるため、正規表現エンジンには単一のバックスラッシュとして渡されます。したがって、正規表現としては\n}となります。

この\n}という正規表現は、「改行の直後に続く閉じ波括弧」にマッチします。Go言語のコーディングスタイルでは、関数の最後の閉じ波括弧は通常、単独の行に配置されます。したがって、この変更により、NewChainコンストラクタ関数の定義全体（関数の開始から、その関数の最後の閉じ波括弧まで）が正確にハイライトされるようになります。

これにより、コードウォークのユーザーは、NewChain関数の完全な実装を視覚的に把握できるようになり、チュートリアルの意図がより明確に伝わるようになりました。これは、コードの構造と範囲を正確に理解するために不可欠な修正です。

関連リンク

参考にした情報源リンク

  • Go Code Walkの概念に関する一般的な情報 (Web検索結果に基づく)
  • 正規表現の基本的な構文に関する情報 (Web検索結果に基づく)
  • XML属性内での特殊文字のエスケープに関する情報 (Web検索結果に基づく)
  • Go言語のコーディングスタイルに関する一般的な情報 (Web検索結果に基づく)