# 画面設計書 18-Annotated Source - Command

## 概要

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

### 本画面の処理概要

この画面は、CoffeeScriptのCLI（コマンドラインインターフェース）ユーティリティである`coffee`コマンドの実装を行うcommand.coffeeのソースコードを、コメントと実装コードを並列表示する形式で解説するドキュメントページである。このモジュールは、コマンドライン引数の解析、ファイルのコンパイル、watchモード、REPLの起動などを担当する。

**業務上の目的・背景**：`coffee`コマンドの内部実装を理解するために必要な画面である。コマンドラインツールの設計パターン、ファイル監視機能（watchモード）、オプション解析など、Node.js CLIアプリケーション開発のベストプラクティスを学ぶことができる。ビルドツールやカスタムCLIを開発する際の参考となる。

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

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

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

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

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 19 | coffeeコマンド | 主機能 | CLIコマンドcommand.coffeeのソースコード解説表示 |
| 20 | --compile オプション | 補助機能 | コンパイルオプションの解説を含む |
| 21 | --watch オプション | 補助機能 | ファイル監視オプションの解説を含む |

## 画面種別

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

## URL/ルーティング

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

## 入出力項目

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

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

## 表示項目

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

---

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

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

### 推奨読解順序

#### Step 1: 依存関係とグローバル設定を理解する

CLIモジュールの初期化と設定を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | command.coffee | `src/command.coffee` | 行7-14: 依存モジュールのインポート |
| 1-2 | command.coffee | `src/command.coffee` | 行27-31: BANNER定義 - ヘルプメッセージ |
| 1-3 | command.coffee | `src/command.coffee` | 行34-56: SWITCHES定義 - オプション一覧 |

**読解のコツ**: SWITCHESは[短縮フラグ, 長形式フラグ, 説明]の3要素配列である。これがoptparse.coffeeに渡される。

#### Step 2: メイン処理フローを理解する

run関数からの処理分岐を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | command.coffee | `src/command.coffee` | 行72以降: `run`関数 - エントリーポイント |
| 2-2 | command.coffee | `src/command.coffee` | オプション解析とモード分岐 |
| 2-3 | command.coffee | `src/command.coffee` | `compileScript`関数 - ファイルコンパイル |

**主要処理フロー**:
1. **parseOptions()**: コマンドライン引数を解析
2. **分岐処理**: help/version/interactive/stdio/evalなど
3. **compileScript()**: 実際のコンパイル処理
4. **watch()**: ファイル監視（--watchオプション時）

#### Step 3: 各機能の実装を理解する

個別機能の実装詳細を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | command.coffee | `src/command.coffee` | `compileStdio`関数 - 標準入力からコンパイル |
| 3-2 | command.coffee | `src/command.coffee` | `watch`関数 - ファイル監視 |
| 3-3 | command.coffee | `src/command.coffee` | `writeJs`関数 - ファイル出力 |

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

```
command.html (生成されたHTML)
    |
    +-- command.coffee (ソースファイル)
           |
           +-- optparse.coffee
           |      +-- OptionParser
           |
           +-- coffeescript.coffee
           |      +-- compile()
           |      +-- run()
           |
           +-- repl.coffee (--interactive時)
           |      +-- start()
           |
           +-- fs (Node.js)
           |      +-- readFile
           |      +-- writeFile
           |      +-- watch
           |
           +-- path (Node.js)
           +-- child_process (Node.js)
```

### データフロー図

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

コマンドライン引数   --->   parseOptions()      --->   オプションオブジェクト
       |                           |
       v                           v
入力ファイル        --->   compileScript()     --->   .jsファイル
       |                           |
       |                           +-- CoffeeScript.compile()
       |                           +-- writeJs()
       |
       +-- .coffeeファイル
       +-- 標準入力（--stdio）
       +-- 文字列（--eval）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| command.html | `docs/v1/annotated-source/command.html` | 生成HTML | 本画面のHTMLファイル |
| command.coffee | `src/command.coffee` | ソース | CLIコマンド実装 |
| optparse.coffee | `src/optparse.coffee` | ソース | オプション解析 |
| coffeescript.coffee | `src/coffeescript.coffee` | ソース | コンパイル処理 |
| repl.coffee | `src/repl.coffee` | ソース | REPL（--interactive時） |
| docco.css | `docs/v1/annotated-source/docco.css` | スタイル | ページスタイル定義 |
