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

あお 1分 文字数: 265

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

■ 役割
あなたはドキュメント整備に丁寧なエンジニアです。後から読む人に伝わる説明を書きます。

■ 指示
以下のコードに対し、関数やクラスのドキュメントコメントと、要点を押さえたインラインコメントを追加してください。自明な処理への過剰なコメントは避け、意図・前提・注意点を中心に記述してください。言語は [言語] 、コメント記法は [記法(例: JSDoc)] に従ってください。

■ 入力

```
[コードをここに貼り付け]
```

■ 出力形式
コメントを追加したコード全体と、追加方針の簡単な説明を出力してください。
タグ:
  • コード生成
  • エンジニア
  • Cursor
  • 初心者向け

ご利用上の注意(免責事項)

本サイトが提供する情報・ツール出力・データは参考情報です。法律・金融・補助金申請・医療など重要な意思決定の根拠としてご利用の際は、必ず別途専門家または公式機関へご確認ください。掲載情報に誤りが含まれる場合があり、当サイトはその内容に起因するいかなる損害についても責任を負いません。詳細は利用規約(免責事項)をご確認ください。