ノート

WHYをコメントせよ、WHATではない - コードコメント用プロンプト

フリーのプロンプト百科事典 Wikiprompt より

Nas
投稿者NasX出典

2026年3月9日

WHYをコメントせよ、WHATではない - コードコメント用プロンプト コードの背後にある理由を説明するコードコメントを生成するためのプロンプトテンプレート。単に何をするかだけでなく、なぜそうするのかを説明します。

プロンプト内容保存

🌐
悪いコードコメント(何):「// リストをソートする」 良いコードコメント(なぜ):「// ユーザーがA-Zを期待するため、アルファベット順にソートする」 私のプロンプト:「短くして」 彼のスタイル:「モバイルユーザーは流し読みするため、100語以内に保つ」 文脈=より良い実行。 古い知恵:ルールだけでなく理由を説明する。

ログインして完全なプロンプトを表示

次で続行:

ログインすると、次に同意したことになります: 利用規約 プライバシーポリシー

使い方

このプロンプトは coding 向けに設計されています。上の内容をコピーして、お好みの AI ツールに貼り付けてください。

最良の結果を得るには、プレースホルダー(角括弧や大文字で示された部分)を具体的な要件に置き換えてください。

参考資料

カテゴリ:coding| twitter| code-comments| why-not-what

ノート