# 通知設計書 20-block comment error

## 概要

本ドキュメントは、CoffeeScriptコンパイラにおける「block comments cannot contain {content}」（ブロックコメント内禁止文字エラー）通知の設計仕様を定義する。

### 本通知の処理概要

この通知は、CoffeeScriptソースコード内のブロックコメント（`### ... ###`）内に禁止された文字列（`*/`）が含まれている場合に発生する構文エラーを開発者に通知するものである。

**業務上の目的・背景**：CoffeeScriptのブロックコメント（`### ... ###`）はJavaScriptの`/* ... */`コメントに変換される。JavaScriptのブロックコメントでは`*/`がコメント終了を示すため、CoffeeScriptのブロックコメント内に`*/`が含まれていると、生成されるJavaScriptが壊れてしまう。この通知により、開発者はコンパイル時に問題を発見し、コメント内容を修正できる。

**通知の送信タイミング**：字句解析（Lexer）フェーズにおいて、`commentToken`メソッドがブロックコメント（herecomment）を処理する際に発生する。HERECOMMENT_ILLEGAL正規表現でマッチした場合に検出される。

**通知の受信者**：CoffeeScriptコードをコンパイルしている開発者。コマンドラインツール、REPL、またはプログラムからの呼び出し時に、標準エラー出力またはエラーオブジェクトとして通知される。

**通知内容の概要**：エラーメッセージ「block comments cannot contain {content}」と、該当するソースコード内の位置情報（行番号・列番号）、および禁止された内容（`*/`）が含まれる。

**期待されるアクション**：開発者は該当するブロックコメント内の`*/`を削除するか、別の表現（例: `* /`とスペースを挿入）に置き換える必要がある。または、正規表現をコメント内に含める場合は、その部分を別の場所に移動することを検討する。

## 通知種別

コンパイルエラー（SyntaxError）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時即時） |
| 優先度 | 高（コンパイル停止） |
| リトライ | なし |

### 送信先決定ロジック

コンパイラ呼び出し元に対してエラーがスローされる。CLIの場合は標準エラー出力、プログラムAPIの場合は例外としてスローされる。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | `[ファイル名]:行:列: error: block comments cannot contain {content}` |
| 形式 | テキスト |

### 本文テンプレート

```
[stdin]:2:12: error: block comments cannot contain */
###
  Regex: /a*/g
           ^^
###
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| content | 禁止された内容（`*/`） | HERECOMMENT_ILLEGALマッチ結果 | Yes |
| first_line | エラー発生行番号 | Lexer.getLineAndColumnFromChunk | Yes |
| first_column | エラー発生列番号 | Lexer.getLineAndColumnFromChunk | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | commentTokenメソッド実行 | `HERECOMMENT_ILLEGAL.exec hereComment`がマッチ | ブロックコメント内に`*/`を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 正常コメント | ブロックコメント内に`*/`が含まれていない場合はエラーなし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ソースコード読み込み] --> B[commentTokenメソッド呼び出し]
    B --> C{ブロックコメント?}
    C -->|Yes| D[HERECOMMENT_ILLEGAL.exec hereComment]
    C -->|No| E[行コメント処理]
    D --> F{マッチ?}
    F -->|Yes| G[error 'block comments cannot contain' 呼び出し]
    F -->|No| H[通常処理継続]
    G --> I[throwSyntaxError]
    I --> J[コンパイル停止]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（ファイルベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SyntaxError | ブロックコメント内に`*/`が含まれる | `*/`を削除するか、スペースで分離 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

該当なし（即時エラー通知）

### 配信時間帯

制限なし

## セキュリティ考慮事項

特になし。ソースコードの内容がエラーメッセージに含まれる可能性があるが、開発時のみ表示されるため問題なし。

## 備考

- CoffeeScriptのブロックコメント（`### ... ###`）はJavaScriptの`/* ... */`に変換される
- HERECOMMENT_ILLEGAL定数: `/\*\//`で`*/`を検出
- 正規表現を含むコメントで発生しやすい（例: `### Regex: /a*/g ###`）
- 代替手段として、`*/`を`* /`のようにスペースで分離するか、コメントを行コメント（`#`）に分割する

---

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

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

### 推奨読解順序

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

コメント処理用の正規表現を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lexer.coffee | `src/lexer.coffee` | HERECOMMENT_ILLEGAL定数（1398行目）を確認 |

**読解のコツ**: `HERECOMMENT_ILLEGAL = /\*\//`は`*/`をマッチする正規表現。`*`と`/`はエスケープされている。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lexer.coffee | `src/lexer.coffee` | commentTokenメソッド（330行目〜）がエントリーポイント |

**主要処理フロー**:
1. **330行目**: `commentToken`メソッド開始
2. **331行目**: `COMMENT.match`でコメントをマッチ
3. **336行目**: `if hereComment`でブロックコメントを判定

#### Step 3: 実際のエラー検出ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lexer.coffee | `src/lexer.coffee` (337-340行) | HERECOMMENT_ILLEGALチェックとエラー発生 |

**主要処理フロー**:
- **337行目**: `matchIllegal = HERECOMMENT_ILLEGAL.exec hereComment`でマッチング
- **338行目**: `if matchIllegal`で条件判定
- **339-340行目**: `@error "block comments cannot contain #{matchIllegal[0]}"`でエラー発生
- **offset: '###'.length + matchIllegal.index**でエラー位置を指定

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

```
CoffeeScript.compile(source)
    │
    └─ Lexer.tokenize(code)
           │
           ├─ commentToken()
           │      ├─ COMMENT.match()でコメント検出
           │      ├─ if hereComment
           │      │      └─ HERECOMMENT_ILLEGAL.exec(hereComment)
           │      │             └─ error('block comments cannot contain...')
           │      │                    └─ throwSyntaxError()
           │      └─ 行コメント処理
           │
           └─ 他のトークン処理メソッド
```

### データフロー図

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

###                       Lexer.commentToken()              SyntaxError例外
  Regex: /a*/g  ────▶           │
###                       HERECOMMENT_ILLEGAL.exec()
     │                          ↓
     │                    matchIllegal[0] = "*/"
     │                          ↓
     └────────────▶ エラーメッセージ生成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lexer.coffee | `src/lexer.coffee` | ソース | 字句解析器本体、commentTokenメソッド（330-420行目） |
| lexer.coffee | `src/lexer.coffee` | ソース | HERECOMMENT_ILLEGAL定数（1398行目） |
| helpers.coffee | `src/helpers.coffee` | ソース | throwSyntaxError関数の定義 |
| error_messages.coffee | `test/error_messages.coffee` | テスト | block comment errorのテストケース（556-566行目） |
