# 画面設計書 14-Annotated Source - Scope

## 概要

本ドキュメントは、CoffeeScript v1のソースコード解説ページ「Annotated Source - Scope」の画面設計書である。Doccoを使用して自動生成されたドキュメントページで、scope.litcoffeeのソースコードとその解説を並列表示する。

### 本画面の処理概要

この画面は、CoffeeScriptコンパイラのスコープ管理を行うscope.litcoffeeのソースコードを、Literate CoffeeScript形式のマークダウンテキストと実装コードを並列表示する形式で解説するドキュメントページである。Scopeクラスは、変数のレキシカルスコープを追跡し、適切なvar宣言を生成する役割を持つ。

**業務上の目的・背景**：CoffeeScriptがどのように変数スコープを管理し、JavaScript出力時にvar宣言を生成するかを理解するために必要な画面である。CoffeeScriptでは変数宣言キーワードがなく、代入時に自動的にスコープが決定される。この仕組みを理解することで、意図しない変数シャドウイングやグローバル汚染を防ぐ知識を得られる。

**画面へのアクセス方法**：v1ドキュメントページ（docs/v1/index.html）のAnnotated Sourceセクション、またはAnnotated Source - Index（docs/v1/annotated-source/index.html）から「scope.litcoffee」リンクをクリックしてアクセスする。直接URL（docs/v1/annotated-source/scope.html）でもアクセス可能である。

**主要な操作・処理内容**：
1. ソースコードとコメントの並列表示を閲覧する
2. 「Jump To...」メニューから他のソースファイル解説ページへ遷移する
3. セクション番号リンク（pilcrow）をクリックして特定のコードセクションへの直接リンクを取得する
4. Scopeクラスの各メソッド（add、find、check、freeVariable等）の解説を確認する

**画面遷移**：
- 遷移元: v1ドキュメント（docs/v1/index.html）、Annotated Source - Index（docs/v1/annotated-source/index.html）、他のAnnotated Sourceページ
- 遷移先: Jump Toメニューから他のすべてのAnnotated Sourceページ

**権限による表示制御**：本画面は静的HTMLファイルであり、認証・認可の仕組みは存在しない。すべてのユーザーが同一の内容を閲覧できる。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 17 | スコープ管理 | 主機能 | スコープ管理scope.litcoffeeのソースコード解説表示 |

## 画面種別

詳細（ドキュメント閲覧画面）

## URL/ルーティング

- URL: `/docs/v1/annotated-source/scope.html`
- 静的HTMLファイルとして配置

## 入出力項目

本画面は静的HTMLであり、ユーザー入力項目は存在しない。

| 項目名 | 入出力 | 型 | 必須 | 説明 |
|--------|--------|-----|------|------|
| - | - | - | - | 入力項目なし |

## 表示項目

| 項目名 | データ型 | 説明 |
|--------|----------|------|
| ページタイトル | テキスト | "scope.litcoffee" |
| ソースコード | HTML（ハイライト済み） | scope.litcoffeeの全ソースコード |
| コメント/解説 | HTML | Literate形式のマークダウンテキスト |
| Jump Toメニュー | リンクリスト | 他のソースファイルへのナビゲーション |
| セクションリンク | アンカーリンク | 各セクションへの直接リンク（#section-N形式） |

## イベント仕様

### 1-Jump Toメニュークリック

Jump Toリンクをクリックすると、対応するソースコード解説ページへ遷移する。

- イベントタイプ: クリック
- 対象要素: `#jump_to a.source`
- 処理内容: 指定されたHTMLファイルへのページ遷移

### 2-セクションリンククリック

各セクションの段落記号（pilcrow: &#182;）をクリックすると、そのセクションへの直接リンクがブラウザのURLバーに表示される。

- イベントタイプ: クリック
- 対象要素: `a.pilcrow`
- 処理内容: URLハッシュの変更（#section-N）

## データベース更新仕様

### 操作別データベース影響一覧

本画面は静的HTMLファイルであり、データベース操作は発生しない。

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| - | - | - | データベース操作なし |

## メッセージ仕様

本画面は静的HTMLであり、動的なメッセージ表示機能は存在しない。

| メッセージID | 種別 | メッセージ内容 | 表示条件 |
|-------------|------|---------------|----------|
| - | - | - | - |

## 例外処理

本画面は静的HTMLであり、アプリケーションレベルの例外処理は存在しない。
- HTTPレベル: 404 Not Found（ファイルが存在しない場合）
- HTTPレベル: 500 Internal Server Error（サーバー設定エラー等）

## 備考

- 本画面はDoccoツールによって自動生成されたHTMLファイルである
- ソースコードはsrc/scope.litcoffeeから生成される
- Literate CoffeeScript形式：マークダウンテキストとコードが混在
- スタイルシートはdocco.cssを使用
- v2系にも同様のページ（docs/v2/annotated-source/scope.html）が存在する

---

## コードリーディングガイド

本画面を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

Scopeクラスが管理するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | scope.litcoffee | `src/scope.litcoffee` | 行8: `exports.Scope = class Scope` - クラス定義 |
| 1-2 | scope.litcoffee | `src/scope.litcoffee` | 行17-21: コンストラクタ - variables、positions、utilities |

**読解のコツ**: Literate CoffeeScriptでは、インデントされたブロックがコードであり、インデントされていない部分がマークダウンテキストである。

#### Step 2: 主要メソッドを理解する

Scopeクラスの各メソッドの役割を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | scope.litcoffee | `src/scope.litcoffee` | 行29-34: `add`メソッド - 変数追加/上書き |
| 2-2 | scope.litcoffee | `src/scope.litcoffee` | 行49-52: `find`メソッド - 変数検索と宣言 |
| 2-3 | scope.litcoffee | `src/scope.litcoffee` | 行64-65: `check`メソッド - 変数存在確認 |
| 2-4 | scope.litcoffee | `src/scope.litcoffee` | 行90-97: `freeVariable`メソッド - 一時変数生成 |

**主要処理フロー**:
1. **コンストラクタ**: parent、expressions、method、referencedVarsを受け取り初期化
2. **add**: 変数を追加または既存の型を更新
3. **find**: 変数が存在するか確認し、なければ追加
4. **check**: 親スコープを含めて変数の存在を確認
5. **freeVariable**: コンパイラ生成変数（_ref、_len等）の一意な名前を生成

#### Step 3: スコープ階層を理解する

親子関係によるスコープチェーンの仕組みを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | scope.litcoffee | `src/scope.litcoffee` | 行25: `@root = @parent?.root ? this` |
| 3-2 | scope.litcoffee | `src/scope.litcoffee` | 行42-44: `namedMethod` - 親スコープへの探索 |

### プログラム呼び出し階層図

```
scope.html (生成されたHTML)
    |
    +-- scope.litcoffee (ソースファイル)
           |
           +-- (使用元) nodes.coffee
                  |
                  +-- Code.compileNode
                  |      +-- new Scope(parentScope, ...)
                  |
                  +-- Base.compile
                         +-- scope.find()
                         +-- scope.freeVariable()
```

### データフロー図

```
[入力]                              [処理]                              [出力]

Code.compileNode    --->   Scope(parent, expressions)   --->   var宣言文字列
       |                           |
       |                           +-- variables: [{name, type}]
       |                           +-- positions: {name: index}
       |                           +-- root: トップレベルScope
       |
       +-- 親Scope
       +-- Block式
       +-- メソッド情報
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| scope.html | `docs/v1/annotated-source/scope.html` | 生成HTML | 本画面のHTMLファイル |
| scope.litcoffee | `src/scope.litcoffee` | ソース | スコープ管理クラス |
| nodes.coffee | `src/nodes.coffee` | ソース | Scopeの使用元 |
| docco.css | `docs/v1/annotated-source/docco.css` | スタイル | ページスタイル定義 |
