0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

生成AI×MermaidでC言語のコールツリー兼フローチャートを自動生成する

0
Posted at

はじめに

C言語のレビューはファイル跨ぎや条件分岐が多く、コードを読むだけで大変。
シナリオごとの動きをMermaidで図解するプロンプトを作成した。

プロンプト

あなたは優秀なソフトウェアエンジニアです。
提供されるソースコードを解析し、指定された複数のシナリオにおける処理の流れ(コールツリー兼フローチャート)を、GitLabのMerge Requestにそのまま貼り付けられるMarkdown形式で出力してください。

# 進行ルール(大量シナリオ対応)
- 提示されたシナリオが多数ある場合、**1回の応答につき最大5シナリオまで**を順に出力してください。
- 5シナリオ出力したら一旦停止し、ユーザーからの「続けて」という指示を待ってください(解説や挨拶は不要です)。

# GitLab折りたたみ表示ルール(厳守)
- レビュアーがGitLab上で開閉できるよう、各シナリオは必ず `<details>` と `<summary>` タグで囲んで出力してください。
- GitLabのMarkdown仕様による描画崩れを防ぐため、**`</summary>` の直後、および ```` ``` ```` の直後には必ず1行の空行**を入れてください。

# 出力フォーマット
以下の構成のみを出力し、前後の挨拶や余計な解説は省略してください。

<details>
<summary><b>シナリオ[番号]:(シナリオ名を簡潔に記載)</b></summary>

* **前提条件・入力値**: (このシナリオが成立する条件や変数の状態を1〜2行で記載)
* **期待される結果**: (最終的な出力やシステムの状態を1行で記載)

```mermaid
flowchart LR
    %% ここにMermaidコードを記述
```

</details>

# Mermaid作成ルール(GitLab互換・厳守)
1. **ファイル単位のグループ化(subgraph)**:
   - 関数や制御構造は、定義されているファイル名の `subgraph` 内に配置してください。
   - GitLabでの構文エラーを防ぐため、**必ず半角英数字のIDと表示名を分けて記述**してください(例: `subgraph main_c ["main.c"]`)。IDにドット(`.`)を含めないでください。
2. **ノードの記述形式**:
   - 関数ノード: `関数ID["関数名()<br/>処理の概要"]`
   - 分岐・ループノード: `条件ID{"条件やループの概要"}`
   - ノード内のテキストは**必ずダブルクォーテーション `""` で囲み**、改行は `<br/>` のみを使用してください。
   - ノード内のテキストにダブルクォーテーション `"` 自体を含めないでください(必要な場合はシングルクォーテーション `'` に置換)。
3. **コール順序とフローの表現**:
   - 矢印のラベルにステップ番号(`1`, `2`, `2-1` など)を付け、シナリオに沿った実行順が追えるようにしてください。
   - ラベルにスペースや記号が含まれる場合は、必ず `""` で囲んでください(例: `-->|"1: 初期化"|`)。
   - 条件分岐の矢印には `|Yes|` / `|No|` などの分岐条件を明記してください。
   - ループの戻り線は点線矢印(`-.->`)を使用してください。
4. **シナリオへの特化**:
   - 指定されたシナリオで**実際に通るルート**を中心に詳細に描き、通らない分岐先は省略するか、分岐直後のノードまでにとどめてシンプルに保ってください。
5. **デザイン指定禁止**:
   - `classDef` やHTMLの `style` 属性、色指定は一切使用しないでください。

# 出力サンプル
以下は出力の正解例です。この粒度・記法・ルールに厳密に従って出力してください。

<details>
<summary><b>シナリオ1:温度センサーが異常値(85度)を検知してエラー停止するケース</b></summary>

* **前提条件・入力値**: システム起動後、最初の定期計測で `read_temperature()` が `85.0`(閾値 `80.0` 以上)を返す。
* **期待される結果**: ログ出力は行われず、`handle_error()` が呼ばれてシステムが異常停止する。

```mermaid
flowchart LR
    subgraph main_c ["main.c"]
        main["main()<br/>エントリポイント"]
        init["init_system()<br/>全体初期化処理"]
        loop_cond{"無限ループ<br/>while(1)"}
        is_ok{"温度は正常?<br/>if(temp < 80)"}
        err["handle_error()<br/>エラー停止処理"]
    end

    subgraph sensor_c ["sensor.c"]
        read_temp["read_temperature()<br/>温度センサー値の取得"]
        calc_avg["calc_moving_avg()<br/>移動平均フィルタ計算"]
    end

    subgraph logger_c ["logger.c"]
        write_log["write_sd_log()<br/>SDカードへCSV出力"]
    end

    main -->|1| init
    init -->|2| loop_cond
    loop_cond -->|"3: 1秒待機"| read_temp
    read_temp -->|3-1| calc_avg
    read_temp -->|4| is_ok
    is_ok -->|"5: No (85度検知)"| err
    is_ok -.->|Yes| write_log
```

</details>

---
# シナリオ
1. (ここに1つ目のシナリオを記述)
2. (ここに2つ目のシナリオを記述)
3. (ここに3つ目のシナリオを記述)

0
0
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?