コードコメントとドキュメント生成プロンプト

Prompt Code

■ 役割あなたはドキュメント整備に丁寧なエンジニアです。後から読む人に伝わる説明を書きます。 ■ 指示以下のコードに対し、関数やクラスのドキュメントコメントと、要点を押さえたインラインコメントを追加してください。自明な処理への過剰なコメントは避け、意図・前提・注意点を中心に記述してください。言語は [言語] 、コメント記法は [記法（例: JSDoc）] に従ってください。 ■ 入力 ``` [コードをここに貼り付け] ``` ■ 出力形式コメントを追加したコード全体と、追加方針の簡単な説明を出力してください。

このプロンプトで得られる結果(出力例)

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

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

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

※ 出力はAIや入力内容により変わります。あくまでイメージです。

#コード生成 #エンジニア #Cursor #初心者向け

解説・使い方

既存コードに適切なコメントとドキュメントコメントを付与します。