AIプロンプト集 | GENAI&

JSDoc 記法でコメントを付与した例です。

/**
 * 税込み価格を計算する。
 * @param {number} price - 税抜き価格（円）
 * @param {number} rate - 税率（例: 0.1）
 * @returns {number} 円未満を切り捨てた税込み価格
 */
function withTax(price, rate) {
  // 端数は切り捨てて整数の円に揃える
  return Math.floor(price * (1 + rate));
}

追加方針：関数には引数・戻り値・前提を JSDoc で明記し、インラインコメントは切り捨ての意図など自明でない箇所のみに絞りました。

例: TypeError: cannot read properties of undefined (reading length)

意味：値が undefined（未定義）の状態で、その length を読もうとして失敗しています。つまり対象がまだ存在していません。

想定される原因

• 配列やオブジェクトを取得する前に参照している（非同期処理の完了待ち漏れ）。
• API のレスポンス構造が想定と異なり、目的のプロパティが無い。

確認・対処の手順

• 該当行の直前で対象の値を出力し、undefined になっていないか確認する。
• items && items.length のように存在チェックを入れる。

再発防止：外部データは取得後に存在確認、またはオプショナルチェーン (?.) を使う習慣をつけます。

通知をAPI内で同期送信する設計案へのレビュー例です。

良い点：構成がシンプルで初期実装が速く、依存コンポーネントが少ない。

懸念点

• 可用性・高：通知先が遅延・障害すると本処理のレスポンスまで巻き込まれる。
• スケーラビリティ・中：リクエスト増加時に外部送信がボトルネックになりやすい。

代替案と推奨：通知をキュー（メッセージブローカー）へ積み、ワーカーで非同期処理する方式を推奨します。本処理の応答性を保てます。

未決事項：通知の到達保証レベル（at-least-once か）と、失敗時のリトライ方針を確認してください。

ログイン時のエラーハンドリング追加を想定した例です。

fix(auth): ログイン失敗時に明示的なエラーを返す

- 認証失敗時に空レスポンスを返していた問題を修正
- 401 とメッセージを返却し、フロント側で分岐できるように変更
- 影響範囲: ログインAPIのみ

Refs: #142

件名は type(scope): 要約 の形式、本文は理由と影響範囲、フッターに関連Issueを記載しています。

最適化後のSQL

SELECT o.id, o.total
FROM orders o
WHERE o.status = paid
  AND o.created_at >= 2026-01-01
ORDER BY o.created_at DESC
LIMIT 50;

改善ポイント

• 関数で包んだ日付比較（YEAR(created_at)）を範囲条件に置き換え、インデックスが効くようにしました。
• SELECT * を必要な列のみに絞り、I/O を削減。

追加インデックス案：status と created_at の複合インデックス (status, created_at) を作成すると、絞り込みと並び替えの両方を1つのインデックスで処理できます。

郵便番号（123-4567 形式）をマッチさせる例です。

正規表現

^\d{3}-\d{4}$

各部分の意味

• ^ 行頭、$ 行末で全体一致を強制
• \d{3} 数字3桁、ハイフン、\d{4} 数字4桁

テスト結果

• 123-4567 → 一致
• 1234567 → 不一致（ハイフン無し）
• 12-34567 → 不一致（桁数違い）

注意点：全角数字は \d に含まれないため、必要なら事前に半角へ正規化してください。

対象は2つの整数を割る divide(a, b) を想定したテスト一式です。

def test_divide_normal():
    assert divide(10, 2) == 5

def test_divide_negative():
    assert divide(-6, 3) == -2

def test_divide_by_zero():
    with pytest.raises(ZeroDivisionError):
        divide(1, 0)

カバーしたケース一覧

• 正常系 / 入力 10,2 / 期待 5
• 境界・負数 / 入力 -6,3 / 期待 -2
• 異常系 / 入力 1,0 / 期待 ZeroDivisionError

リファクタリング後のコード

def apply_discount(price, is_member):
    if price <= 0:
        return 0
    rate = 0.2 if is_member else 0.1
    return round(price * (1 - rate))

主な変更点

• ネストした if を早期リターンに変更し、読みやすさを改善。
• 割引率をマジックナンバーから rate 変数へ抽出し意図を明確化。
• 関数名を calc から apply_discount に変更し役割を明示。

挙動が変わらない確認観点：会員・非会員・価格0以下の各ケースで戻り値が従来と一致することをテストで確認します。

原因候補

• 確度 高：辞書に存在しないキーへ角括弧でアクセスし KeyError。入力データに対象キーが無いケースがある。
• 確度 低：キー名のタイプミス（例: user_id と userId の混在）。

検証手順：例外発生直前で対象 dict の keys() を出力し、想定キーが含まれるか確認する。

修正パッチ（差分）

- name = data[user][name]
+ name = data.get(user, {}).get(name, ゲスト)

再発防止：外部入力の辞書アクセスは get でデフォルト値を与えるか、事前にキーの有無を検証する方針を統一します。

概要サマリ：ファイル読み込み関数です。動作はしますが、例外時にファイルハンドルが閉じられず、エラーも握りつぶされています。

重要度別の指摘

• 高：open したファイルが close されない。例外発生時にリソースリークになります。修正案: with 文を使う。
• 中：except で例外を無視しているため、障害が表面化しません。少なくともログ出力を。
• 低：関数名 getdata が役割を表していません。read_user_config 等が明確です。

修正後のコード例

def read_user_config(path):
    with open(path, encoding=utf-8) as f:
        return f.read()

with 文によりブロックを抜ける際に必ず close され、例外も呼び出し側へ伝播します。

ペルソナA(メイン)

• 佐藤美咲 / 32歳 / 都内勤務のWebデザイナー / 年収450万
• 悩み: 残業が多く自己投資の時間がない
• 情報源: Instagram・YouTube・はてなブックマーク
• 購買決定: 口コミと無料トライアルの有無を重視
• 離脱リスク: 価格が不透明だと離れる

ペルソナB(サブ): 学生・コスト重視・SNS経由で流入…

評価フレーム(コンテンツ作成用途・3名チーム)

総合: 用途が日本語ライティング中心ならツールA推奨。コスト最優先ならB。移行コストは小。