# 通知設計書 38-warnCommentXIgnored

## 概要

本ドキュメントは、Nimコンパイラにおいて定義されている警告「warnCommentXIgnored」の設計仕様を記述する。この警告は、特定のコンテキストでコメントが無視された場合に通知される予定であったが、現在は使用されていない（予約済み警告）。

### 本通知の処理概要

本警告は、コンパイラがソースコード内のコメントを何らかの理由で無視した場合に開発者へ通知することを目的として定義されている。ただし、現在のNimコンパイラ実装では、この警告を発行するコードは存在しない。

**業務上の目的・背景**：コンパイラがコメントを無視する状況（例：特定のプラグマコメント、条件付きコンパイル、メタプログラミングなど）で、開発者に通知することで意図しないコメントの無視を防止することを目的として定義された。

**通知の送信タイミング**：現在、この警告を発行するトリガーは存在しない。将来的な拡張のために予約されている。

**通知の受信者**：Nimソースコードを編集している開発者。

**通知内容の概要**：「comment '$1' ignored」形式で、無視されたコメントの内容が通知される予定。$1には無視されたコメントの内容が入る。

**期待されるアクション**：開発者は無視されたコメントの意図を確認し、必要に応じてコメントの形式や配置を修正する。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力）- 現在未使用

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Warning） |
| リトライ | 無 |
| 状態 | 未使用（予約） |

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

コンパイラの設定に基づき、標準エラー出力へ警告メッセージを出力する予定。`--warning[CommentXIgnored]:off`オプションで抑止可能（オプション名は定義済み）。

## 通知テンプレート

### コンパイラ警告メッセージの場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準エラー出力 |
| 重要度 | Warning |
| メッセージID | CommentXIgnored |
| 形式 | テキスト |

### メッセージテンプレート

```
{ファイルパス}({行},{列}) Warning: comment '{コメント内容}' ignored [CommentXIgnored]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 無視されたコメント内容 | 未定義 | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 未定義 | - | - | 現在トリガーなし |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning[CommentXIgnored]:off | コマンドラインオプションで警告を無効化 |
| {.warning[CommentXIgnored]:off.} | ソースコード内プラグマで警告を無効化 |

## 処理フロー

### 送信フロー

現在、この警告を発行する処理フローは存在しない。

```mermaid
flowchart TD
    A[警告定義のみ存在] --> B[発行コードなし]
    B --> C[将来的な拡張のため予約]
```

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

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0 |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

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

- コメント内容がメッセージに含まれるため、センシティブな情報がコメントに含まれる場合は注意が必要

## 備考

- 現在のNimコンパイラ（compiler/ディレクトリ内）では、この警告を発行するコードは存在しない
- 将来的な機能拡張のために警告定義が予約されている
- TMsgKind列挙型とMsgKindToStr配列に定義は存在する

---

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

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

### 推奨読解順序

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

警告の種類定義のみを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnCommentXIgnoredの定義（64行目）とメッセージ文字列（158行目）を確認 |

**読解のコツ**: この警告は定義のみで、発行するコードは存在しない。grep検索でも他のファイルで使用されていないことが確認できる。

#### Step 2: 使用箇所の確認（現在なし）

現在、この警告を使用するコードは存在しない。将来の実装で使用される可能性がある。

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

```
警告定義 (lineinfos.nim)
    │
    └─ 発行コードなし
           │
           └─ 将来的な拡張のため予約
```

### データフロー図

現在、データフローは存在しない。

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義（TMsgKind） |
