پرامپت‌های آماده

پرامپت توضیح کد: بفهم یک تکه کد چه می‌کند، قدم‌به‌قدم

تستحریریهٔ سرنخ۲۳ آبان ۱۴۰۵۲ دقیقه مطالعه

این نوشته مستقل است و به هیچ برندی وابسته نیست. اگر ابزاری را معرفی کنیم، دلیلش را هم می‌نویسیم. رویهٔ نوشتن · روش بررسی ابزارها

اگر کدی را فقط اجرا می‌کنی ولی نمی‌فهمی، این پرامپت آن را از «چه می‌کند» تا «کجا خطرناک است» توضیح می‌دهد. برای مبتدی‌ها و کسانی که کد همکار یا پروژهٔ قدیمی را ارث برده‌اند مناسب است.

پرامپت آماده
من برنامه‌نویس مبتدی هستم و این تکه کد را از [منبع: مثلاً همکار/پروژه‌ام] دارم. توضیحش بده. ترتیب: ۱. در دو جمله بگو این کد کلاً چه کاری می‌کند. ۲. ورودی‌ها و خروجی‌ها را بگو و یک مثال عددی ساده بزن. ۳. خط‌به‌خط یا بلوک‌به‌بلوک توضیح بده (زبان ساده). ۴. هر جایی که ممکن است خطا بدهد یا خطرناک باشد را بنویس (مثل حذف داده یا امنیت). ۵. سه سؤال بپرس که اگر جوابشان را بدانم یعنی کد را فهمیده‌ام. زبان برنامه‌نویسی: [نام زبان] کد: [کد را اینجا بچسبان]

بخش‌های داخل [کروشه] را با اطلاعات خودت عوض کن.

چطور این پرامپت کار می‌کند

ترتیب قدم‌ها طوری است که اول تصویر کلی را بگیری و بعد وارد جزئیات شوی.

  1. دو جمله کلی: اول بدانی کد برای چیست. وگرنه خط‌به‌خط خواندن بی‌معناست.
  2. مثال عددی: بهترین راه برای فهمیدن تابع، دیدن یک ورودی کوچک و خروجی‌اش است.
  3. خط‌به‌خط ساده: برای هر خط یک جملهٔ فارسی؛ اصطلاحات را هم توضیح می‌دهد.
  4. بخش خطرها: قبل از اجرای کد ناشناس، بدانی کجا ممکن است داده پاک شود یا اطلاعات لو برود.
  5. سه سؤال: فهمیدن را می‌سنجد، نه فقط خواندن را.

یک مثال

فرض کن در پروژه تابعی دیده‌ای که لیستی از اعداد می‌گیرد و چیزی را حذف می‌کند. توضیح خوب می‌گوید «فقط اعداد منفی را از لیست جدا می‌کند»، مثال کوچک می‌زند و هشدار می‌دهد «لیست اصلی را تغییر می‌دهد». این هشدار همان چیزی است که قبل از اجرا باید بدانی.

چطور شخصی‌اش کنیم

  • برای فهمیدن یک پروژهٔ بزرگ، اول نام فایل‌ها را بنویس و «نقش هر فایل» را بپرس.
  • اگر می‌خواهی کد را بهتر کنی، بعد از توضیح بپرس «سه راه برای خواناتر شدنش».
  • اگر کد خطا می‌دهد، متن خطا را هم بچسبان.

اشتباه‌های رایج

  • اجرای کدی که توضیحش را نفهمیده‌ای، مخصوصاً اگر به فایل و دیتابیس دست می‌زند.
  • چسباندن کدی که رمز یا کلید دسترسی دارد.
  • باور کردن توضیح بدون اجرای مثال کوچک.

ادامه

اگر دنبال خودکارسازی با کد هستی، راهنمای اتوماسیون را ببین. و همچنین: برای فهمیدن مفاهیم غیرکد، برای ساختن مسیر یادگیری برنامه‌نویسی. برای فهمیدن منطقِ پشتِ همهٔ این دستورها، راهنمای نوشتن پرامپت را بخوان و فهرست کامل را در کتابخانهٔ پرامپت‌های آماده ببین.

سوالات متداول

اشتراک‌گذاری:تلگرامواتس‌اپایکس
تس

تحریریهٔ سرنخ

تیم نویسندگان و آزمایشگران

ما چند نفریم که هر روز با ابزارهای هوش مصنوعی و اتوماسیون کار می‌کنیم. هر راهنمایی که اینجا می‌بینید اول روی کارِ خودمان امتحان شده و بعد نوشته شده است.