# 画面設計書 19-Annotated Source - Optparse

## 概要

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

### 本画面の処理概要

この画面は、CoffeeScriptのコマンドラインオプション解析を行うoptparse.coffeeのソースコードを、コメントと実装コードを並列表示する形式で解説するドキュメントページである。OptionParserクラスは、`coffee`コマンドの引数解析に使用される。

**業務上の目的・背景**：コマンドラインツールのオプション解析の実装パターンを理解するために必要な画面である。シンプルなオプションパーサーの設計は、Node.js CLIアプリケーション開発の参考となる。短縮フラグ（-c）と長形式フラグ（--compile）の対応、オプション引数の処理、ヘルプメッセージ生成などの実装を学ぶことができる。

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

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

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

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 37 | オプションパーサー | 主機能 | オプション解析optparse.coffeeのソースコード解説表示 |

## 画面種別

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

## URL/ルーティング

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

## 入出力項目

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

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

## 表示項目

| 項目名 | データ型 | 説明 |
|--------|----------|------|
| ページタイトル | テキスト | "optparse.coffee" |
| ソースコード | HTML（ハイライト済み） | optparse.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/optparse.coffeeから生成される
- command.coffeeから使用される
- スタイルシートはdocco.cssを使用
- v2系にも同様のページ（docs/v2/annotated-source/optparse.html）が存在する

---

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

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

### 推奨読解順序

#### Step 1: OptionParserクラスを理解する

オプション解析の中核となるクラスを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | optparse.coffee | `src/optparse.coffee` | 行1: helpers.coffeeからrepeatをインポート |
| 1-2 | optparse.coffee | `src/optparse.coffee` | 行14: `OptionParser`クラス定義 |
| 1-3 | optparse.coffee | `src/optparse.coffee` | 行21-22: コンストラクタ - rules構築 |

**読解のコツ**: OptionParserは[短縮フラグ, 長形式フラグ, 説明]の配列を受け取り、解析ルールを構築する。

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

引数解析の処理フローを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | optparse.coffee | `src/optparse.coffee` | 行30以降: `parse`メソッド |
| 2-2 | optparse.coffee | `src/optparse.coffee` | オプションと引数の分離処理 |
| 2-3 | optparse.coffee | `src/optparse.coffee` | `--`（ダブルダッシュ）の処理 |

**主要処理フロー**:
1. **normalizeArguments**: 引数の正規化（短縮フラグの展開）
2. **ルールマッチング**: 各引数をルールと照合
3. **オプションオブジェクト構築**: マッチした値を格納
4. **arguments配列**: 残りの位置引数を格納

#### Step 3: ヘルパー関数を理解する

内部ヘルパー関数の役割を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | optparse.coffee | `src/optparse.coffee` | 行76-81: 正規表現定数（LONG_FLAG、SHORT_FLAG等） |
| 3-2 | optparse.coffee | `src/optparse.coffee` | 行85-98: `buildRules`関数 |
| 3-3 | optparse.coffee | `src/optparse.coffee` | `normalizeArguments`関数 |

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

```
optparse.html (生成されたHTML)
    |
    +-- optparse.coffee (ソースファイル)
           |
           +-- helpers.coffee
           |      +-- repeat (ヘルプ表示のスペース生成)
           |
           +-- (使用元) command.coffee
                  +-- new OptionParser(SWITCHES, BANNER)
                  +-- parser.parse(process.argv)
```

### データフロー図

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

ルール定義         --->   new OptionParser(rules, banner)
['-c', '--compile', '...']         |
                                   v
process.argv       --->   parser.parse(args)    --->   オプションオブジェクト
       |                           |                          |
       |                           +-- normalizeArguments     +-- compile: true
       |                           +-- ルールマッチング        +-- output: 'dir'
       |                           +-- 値の抽出               +-- arguments: [...]
       |
       +-- ['node', 'coffee', '-c', 'file.coffee']

parser.help()      --->   ヘルプテキスト生成    --->   フォーマット済み文字列
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| optparse.html | `docs/v1/annotated-source/optparse.html` | 生成HTML | 本画面のHTMLファイル |
| optparse.coffee | `src/optparse.coffee` | ソース | オプションパーサー実装 |
| command.coffee | `src/command.coffee` | ソース | optparse使用元 |
| helpers.coffee | `src/helpers.coffee` | ソース | repeat関数提供 |
| docco.css | `docs/v1/annotated-source/docco.css` | スタイル | ページスタイル定義 |
