نوشتن مستندات CodeIgniter

  • سه‌شنبه 21 مهر 1405 ساعت 08:00
  • 3.1.9
  • کامل شده
  • منقضی شده
این داکیومنت از طرف توسعه‌دهنده ساپورت نمی‌شود، جدیدترین ورژن داکیومنت بزودی ترجمه خواهد شد.

مستندات CodeIgniter 3 با قالب reStructuredText نوشته می‌شوند و برای تولید نسخه HTML به ابزار مستندسازی پروژه نیاز دارند. اگر می‌خواهید در مستندات مشارکت کنید، ابتدا مخزن راهنمای کاربر را دریافت کنید، وابستگی‌های ساخت را نصب کنید و تغییرات را در فایل منبع همان صفحه انجام دهید.

ساختار و API اصلی

در اصلاح مستندات، نام کلاس‌ها، متدها، پارامترها و مسیر فایل‌ها را دقیق نگه دارید. مثال باید با نسخه فریمورک سازگار باشد و در صورت نیاز، پیش‌نیاز یا خروجی آن مشخص شود. برای تغییرات بزرگ، ساختار هدینگ‌ها و لینک‌های ارجاعی را نیز بررسی کنید.

نمونه استفاده

git clone https://github.com/bcit-ci/CodeIgniter.git
cd CodeIgniter
# edit user_guide_src/source/...
# build the documentation using the project instructions

نکته مهم

پیش از ارسال Pull Request، خروجی HTML را بسازید و لینک‌های داخلی و کدهای نمونه را بازبینی کنید.

مطالعه مرتبط

برای ادامه مطالعه، MVC، کوئری، ترنزکشن را ببینید.

ساختار پیشنهادی مستندات

صفحه فنی خوب باید پیش‌نیاز، هدف، روش نصب یا فعال‌سازی، نمونه اجرا، خروجی مورد انتظار، محدودیت‌ها و ارجاع به API را پوشش دهد. برای تغییر رفتار، مثال کوچک و قابل بازتولید بنویسید. اگر قابلیت به افزونه PHP یا تنظیم سرور وابسته است، آن پیش‌نیاز را صریح ذکر کنید.

نکات پیاده‌سازی

این قابلیت بخشی از چرخه درخواست CodeIgniter است و باید با Controller، Model و View هماهنگ شود. تنظیمات را در محل مناسب نگه دارید، منطق تجاری را در Controller انباشته نکنید و برای رفتارهای تکرارشونده یک کلاس یا تابع مستقل بسازید. قبل از انتشار، مسیر موفق و مسیر خطا را با داده واقعی اما غیرحساس آزمایش کنید.

بخش ها

سایر پست های داکیومنت

تگ ها