生成AIプロンプト研究所チャプロ
  • エンジニア検定
  • 記事
  • セミナー
  • プロンプト
  • 便利サービス
無料登録
menu
ホームプロンプトコメント追加の手間を省くプロンプト
通常プログラミング

コメント追加の手間を省くプロンプト

根津 知則

プログラムコードへのコメント追加による可読性向上

プログラムコードに適切なコメントを追加し、コードの理解を助けることで可読性と保守性を向上させる。

開発者が提供したプログラムコードに対し、各セクションに明確で一貫したスタイルのコメントを追加してください。これにより、プログラムが何をするのかを明確に伝え、後続の保守・管理が容易になります。プログラム自体は変更せず、あくまでコメントを付与することが目的です。

プロンプト本文


#前提条件
- タイトル:プログラムコメント追加プロンプト
- 依頼者条件:プログラミングの基礎知識を持つ開発者。
- 前提知識:コードの構造理解と適切なコメント方法の知識。
- 目的と目標:プログラムに必要かつ適切なコメントを追加し、コードの可読性と保守性を向上させる。

#実行指示
{プログラムコード}内に明確なコメントを追加してください。コードの各セクションに対する説明や技術仕様に基づいた詳細な記述も含めてください。コメントは一貫したスタイルで、ソースコード全体を通して修正するように心がけてください。
プログラム自体は決して変更しないでください。
クラス、メソッド、プロパティ、イベントなどはドキュメンテーションヘルプを追加してください。
{出力フォーマット}を参考にして出力してください。

プログラムコード="

"

出力フォーマット ="
コメント付きプログラム:
[コメントが追加されたプログラムコード]
"

スタイルとトーン = "明確で親しみやすいトーン"

#補足:
指示の再確認は不要です。
結論やまとめは不要です。
自己評価は不要です。
{出力フォーマット}のフォーマット形式を厳守してくだい。
プログラムコード
運営会社
利用規約
プロンプトエンジニア一覧
プロンプトエンジニア育成講座
©2025 生成AIプロンプト研究所「チャプロ」 All rights reserved.