تحقیقات

نکات موثر در کار تیمی با فریم ورک لاراول

• توسط : علی حسین شهابی
• 0 نظر

با سلام خدمت لاراولی ها عزیز

صحبت امروز به نقل از یکی از دوستان می باشد و به نظرم جالب اومد.

بعضی از دوستان رو می بینم که در نامگذاری ها توی فریم ورک Laravel استانداردها و قراردادها (conventions) را رعایت نمی کنند و بعضا در آینده ممکنه به مشکل بخورن و باید یکسری چیزهارو به صورت دستی تغییر بدن تا مشکلاتشون حل بشه بنابراین تو این مطلب این قراردادها رو لیست میکنم.

قبل از خواندن نکات پایین , ذکر کنم که اجباری در استفاده از این موارد نیست و استفاده از آنها باعث خوانایی , راحتی ارتباط با پروژه ی دیگران و …. می شود.

— اسامی دیتابیس اعم از نام جداول و ستون ها باید به صورت snake_case باشد مثلا ستون first_name یا جدول social_users

— اسامی کلاس ها باید به صورت StudlyCase باشد مثلا کلاس SocialUser

— ثوابت باید به صورت upper case یعنی با حروف بزرگ نوشته شوند با under score از هم جدا شوند مثلا APP_KEY

— نام متد ها باید به صورت camelCase باشد مثلا updatePost

— اسامی پراپرتی های کلاسها و آرگومانهای متدها قرارداد خاصی برای آن تعیین نشده اما پیشنهاد میشه به صورت camelCase نامگذاری شوند

— نام توابع هم به صورت camelCase باید نامگذاری شوند

— متغیرها هم به صورت camelCase نامگذاری شوند

— نام جداول دیتابیس رو به صورت جمع و مدل متناظر با آن را مفرد نامگذاری کنید مثلا مدل Post جدول متناظر آن posts می باشد. در ضمن توجه کنید برای نوشتن جمع طبق گرامر انگلیسی عمل کنید و می توانید برای اینکه متوجه بشید جمع یک اسم چی هست از تابع ()str_plural کمک بگیرید

— در هنگام تعریف ستون کلید خارجی در جداول دیتابیس توجه کنید ابتدا باید نام جدولی که کلید خارجی به آن مرتبط است را به صورت مفرد و بعد در انتهای id_ را اضافه کنید مثلا کلید خارجی user_id یا category_id

— به انتهای نام کنترلرها کلمه Controller را اضافه کنید مثلا کنترلر PostController

اگر نکته ی خاصی به ذهنتون رسید حتما در کامنت ذکر نمایید.