مقدمه
کد تمیز یعنی کدی که نفر بعدی بتواند آن را با کمترین حدس و گمان بفهمد و تغییر دهد. این کیفیت از نامگذاری خوب، مسئولیتهای روشن و احترام به زمان تیم شروع میشود، نه از الگوهای پیچیده.
این مطلب چه مشکلی را حل میکند؟
از کلاس و interface تا composition و type declaration؛ راهنمای عملی نوشتن PHP خوانا و قابل تست با مثالهای واقعی.
نامها باید دلیل وجود کد را توضیح دهند
نامها باید دلیل وجود کد را توضیح دهند؛ activeStudents و calculateInvoiceTotal از data و process مفیدترند.
هر متد را برای یک مسئولیت نگه دارید
هر متد را برای یک مسئولیت نگه دارید؛ اعتبارسنجی، ذخیرهسازی، ارسال ایمیل و گزارش را بیدلیل در یک تابع جمع نکنید.
از type hint
از type hint، return type و قرارداد روشن استفاده کنید تا خطا زودتر پیدا شود و IDE کمک بیشتری بدهد.
تکرار را بعد از فهم تفاوتها حذف کنید
تکرار را بعد از فهم تفاوتها حذف کنید؛ abstraction زودهنگام گاهی تغییرات بعدی را سختتر میکند.
مثال عملی
این قطعه کد یک نقطه شروع کوچک اما قابل اجراست. آن را در پروژه خودت با داده واقعی امتحان کن و بعد بر اساس نیاز محصول گسترش بده.
interface DiscountPolicy
{
public function calculate(int $amount): int;
}
final class FixedDiscount implements DiscountPolicy
{
public function calculate(int $amount): int
{
return min($amount, 100_000);
}
}
مسیر پیشنهادی اجرا
یک سرویس محاسبه سبد خرید بنویس و منطق تخفیف، مالیات و ارسال را از هم جدا نگه دار تا هر بخش مستقل تست شود.
نکته مهم: کدنویسی تمیز یک استاندارد یکباره نیست؛ با بازخورد تست، review و نگهداری واقعی بهتر میشود.
چکلیست اجرای سریع
- نام را بر اساس معنا انتخاب کنید.
- هر متد را با یک جمله توضیح دهید.
- ورودی و خروجی را type کنید.
- قبل از abstraction دو نمونه واقعی را مقایسه کنید.
جمعبندی
در بیشتر پروژهها، خوانایی، صراحت و مسئولیتهای محدود بیشترین سود را ایجاد میکنند.
دیدگاههای کاربران
هنوز دیدگاهی ثبت نشده است. تجربهات از این موضوع را با ما به اشتراک بگذار.
برای ثبت دیدگاه ابتدا وارد حساب خود شوید.