# 画面設計書 16-Annotated Source - CoffeeScript

## 概要

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

### 本画面の処理概要

この画面は、CoffeeScriptコンパイラのメインモジュールであるcoffee-script.coffeeのソースコードを、コメントと実装コードを並列表示する形式で解説するドキュメントページである。このモジュールは、CoffeeScriptのトークン化、構文解析、コンパイルの主要なエントリーポイントを提供する。

**業務上の目的・背景**：CoffeeScriptコンパイラの全体構造と主要APIを理解するために必要な画面である。compile、tokens、nodesなどのエクスポート関数がどのように各モジュールを呼び出してコンパイル処理を行うかを学ぶことができる。カスタムビルドツールやエディタプラグインを開発する際に、このモジュールのAPIを理解することは不可欠である。

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

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

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

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | CoffeeScript コンパイル | 主機能 | メインモジュールcoffeescript.coffeeのソースコード解説表示 |
| 3 | トークン化 | 補助機能 | tokens関数の解説を含む |
| 4 | 構文解析 | 補助機能 | nodes関数の解説を含む |

## 画面種別

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

## URL/ルーティング

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

## 入出力項目

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

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

## 表示項目

| 項目名 | データ型 | 説明 |
|--------|----------|------|
| ページタイトル | テキスト | "coffee-script.coffee" |
| ソースコード | HTML（ハイライト済み） | coffee-script.coffeeの全ソースコード |
| コメント/解説 | HTML | 各コードセクションに対応する解説テキスト |
| 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/coffee-script.coffee（v1）またはsrc/coffeescript.coffee（v2）から生成される
- スタイルシートはdocco.cssを使用
- v2系にも同様のページ（docs/v2/annotated-source/coffeescript.html）が存在する（ファイル名が異なることに注意）
- このモジュールがCoffeeScriptの公開APIの中核である

---

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

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

### 推奨読解順序

#### Step 1: 依存関係を理解する

メインモジュールが依存する各コンポーネントを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | coffeescript.coffee | `src/coffeescript.coffee` | 行6-12: 依存モジュールのインポート |
| 1-2 | coffeescript.coffee | `src/coffeescript.coffee` | Lexer、parser、helpers、SourceMapのインポート |

**読解のコツ**: このモジュールは各コンポーネント（Lexer、Parser、SourceMap等）を統合するファサードパターンを採用している。

#### Step 2: 主要APIを理解する

エクスポートされる各関数の役割を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | coffeescript.coffee | `src/coffeescript.coffee` | 行62: `compile`関数 - メインのコンパイル処理 |
| 2-2 | coffeescript.coffee | `src/coffeescript.coffee` | `tokens`関数 - トークン配列の取得 |
| 2-3 | coffeescript.coffee | `src/coffeescript.coffee` | `nodes`関数 - AST（構文木）の取得 |
| 2-4 | coffeescript.coffee | `src/coffeescript.coffee` | `run`関数 - コンパイルして実行 |

**主要処理フロー**:
1. **行62-**: `compile(code, options)`: メインのコンパイル関数
2. **lexer.tokenize()**: CoffeeScriptコードをトークン化
3. **parser.parse()**: トークンからASTを生成
4. **nodes.compile()**: ASTからJavaScriptを生成
5. **SourceMap**: オプションでソースマップを生成

#### Step 3: エラー処理を理解する

コンパイルエラーの処理方法を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | coffeescript.coffee | `src/coffeescript.coffee` | 行44-50: `withPrettyErrors`関数 |
| 3-2 | coffeescript.coffee | `src/coffeescript.coffee` | SyntaxError更新処理 |

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

```
coffee-script.html (生成されたHTML)
    |
    +-- coffee-script.coffee / coffeescript.coffee (ソースファイル)
           |
           +-- lexer.coffee
           |      +-- Lexer.tokenize()
           |
           +-- parser.js (生成物)
           |      +-- parser.parse()
           |
           +-- nodes.coffee
           |      +-- AST.compile()
           |
           +-- sourcemap.litcoffee
           |      +-- SourceMap
           |
           +-- helpers.coffee
                  +-- updateSyntaxError
```

### データフロー図

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

CoffeeScriptコード   --->   compile(code, options)   --->   JavaScript + SourceMap
       |                           |
       |                           +-- 1. Lexer.tokenize()
       |                           |      -> トークン配列
       |                           +-- 2. parser.parse()
       |                           |      -> AST
       |                           +-- 3. AST.compile()
       |                           |      -> JavaScript
       |                           +-- 4. SourceMap.generate()
       |                                  -> ソースマップ
       |
       +-- オプション
           +-- sourceMap: boolean
           +-- filename: string
           +-- bare: boolean
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| coffee-script.html | `docs/v1/annotated-source/coffee-script.html` | 生成HTML | 本画面のHTMLファイル |
| coffee-script.coffee | `src/coffee-script.coffee` | ソース | メインモジュール（v1命名） |
| coffeescript.coffee | `src/coffeescript.coffee` | ソース | メインモジュール（v2命名） |
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器 |
| parser.js | `lib/parser.js` | 生成JS | 構文解析器 |
| nodes.coffee | `src/nodes.coffee` | ソース | ASTノード |
| sourcemap.litcoffee | `src/sourcemap.litcoffee` | ソース | ソースマップ |
| helpers.coffee | `src/helpers.coffee` | ソース | ヘルパー関数 |
| docco.css | `docs/v1/annotated-source/docco.css` | スタイル | ページスタイル定義 |
