استاندارد نامگذاری در PSR
2024-10-17
در دنیای برنامهنویسی PHP، هماهنگی و خوانایی کدها اهمیت بسیار بالایی دارد. به همین دلیل، استانداردهایی مانند PSR تدوین شدهاند تا از یکپارچگی و سازگاری کدهای PHP اطمینان حاصل شود.
یکی از مهمترین جنبههای این استانداردها، نامگذاری در کدهاست. در این مقاله قصد دارم به صورت خلاصه به قواعد نامگذاری در PSR بپردازم.
PSR-1: استاندارد اولیه کدنویسی
این استاندارد برخی اصول پایهای برای نوشتن کدهای PHP ارائه میدهد:
- نام کلاسها باید به صورت PascalCase باشد، یعنی حرف اول هر کلمه بزرگ نوشته شود.
- مثال:
UserManager
,OrderProcessor
- مثال:
- نام متدها باید به صورت camelCase باشد، یعنی حرف اول کلمه اول کوچک و حروف اول کلمات بعدی بزرگ نوشته شوند.
- مثال:
getUserData()
,processOrder()
- مثال:
- نام ثابتها باید به صورت تمام حروف بزرگ و با استفاده از خط زیر (
_
) بین کلمات نوشته شوند.- مثال:
MAX_CONNECTIONS
,API_KEY
- مثال:
PSR-4: استاندارد اتولودینگ
این استاندارد برای اتولودینگ کلاسها استفاده میشود و مشخص میکند که نامگذاری فضاهای نام (Namespaces) چگونه باید باشد. نام فضاهای نام باید به صورت PascalCase نوشته شوند و ساختار دایرکتوریها باید با ساختار فضاهای نام همخوانی داشته باشد.
- مثال:
App\Controllers
,VendorName\PackageName
PSR-12: استاندارد پیشرفته کدنویسی
این استاندارد تکمیلکننده PSR-1 است و جزئیات بیشتری را برای خواناتر شدن کدها ارائه میدهد. برای مثال:
- نام متغیرها باید به صورت camelCase نوشته شوند.
- مثال:
$userList
,$totalPrice
- مثال:
نتیجهگیری
استانداردهای PSR به ما کمک میکنند تا کدهایی بنویسیم که خوانا، سازگار و به راحتی قابل نگهداری باشند. رعایت این استانداردها به ویژه در پروژههای تیمی اهمیت زیادی دارد، چرا که کدی که امروز نوشته میشود ممکن است فردا توسط فرد دیگری خوانده یا ویرایش شود. بنابراین، با رعایت این اصول ساده میتوانیم پروژههای خود را بهتر مدیریت کنیم و از کیفیت کدها مطمئن شویم.
Welcome to my blog, where I share what I’ve learned in backend development and I’d love to read your comments to improve my knowledge and learn from you ...