راهنمای جامع قوانین نام‌گذاری متغیرها در PHP بر اساس استاندارد گوگل

مقدمه: چرا نام‌گذاری متغیرها در PHP اهمیت دارد؟

نام‌گذاری متغیرها یکی از پایه‌ای‌ترین گام‌ها در نوشتن یک کد تمیز (Clean Code) است. وقتی در یک پروژه تیمی فعالیت می‌کنید یا قصد توسعه پروژه‌های بزرگ را دارید، نام‌گذاری ناهمگون متغیرها می‌تواند فرآیند خطایابی و توسعه را به یک کابوس تبدیل کند. کمپانی بزرگ گوگل برای تمام زبان‌های برنامه‌نویسی از جمله PHP، شیوه‌نامه‌های خاصی ارائه داده است که توسعه‌دهندگان با رعایت آن‌ها می‌توانند کدهایی با خوانایی فوق‌العاده بالا بنویسند.

استاندارد گوگل برای PHP چیست؟

گوگل در شیوه‌نامه‌های متن‌باز خود برای زبان PHP، به شدت به استانداردهای ارائه شده توسط گروه FIG (مخصوصاً استاندارد PSR-1 و PSR-12) تکیه می‌کند. هدف این استانداردها ایجاد یکپارچگی کامل میان توسعه‌دهندگان در سراسر جهان است.

قوانین پایه برای متغیرها در PHP

بر اساس قوانین زبان PHP، متغیرها همیشه با علامت $ شروع می‌شوند و اولین کاراکتر پس از آن باید یک حرف یا خط تیره (underscore) باشد. اما گوگل علاوه بر قوانین نحوی زبان، قوانین سخت‌گیرانه‌تری برای بهبود استایل کد ارائه داده است:

۱. استفاده از استاندارد camelCase برای متغیرها

گوگل توصیه می‌کند که تمام متغیرهای محلی، متغیرهای نمونه و ویژگی‌های کلاس (Properties) باید با فرمت camelCase (شترمرغی) نوشته شوند. در این حالت، کلمه اول با حروف کوچک شروع شده و کلمات بعدی با حروف بزرگ آغاز می‌شوند.

// روش صحیح بر اساس استاندارد گوگل
$userProfileImage = 'avatar.png';
$totalProductPrice = 1500;
$isActive = true;

// روش نادرست (استفاده از snake_case یا حروف بزرگ نامناسب)
$user_profile_image = 'avatar.png';
$TotalProductPrice = 1500;
$is_active = true;

۲. انتخاب نام‌های توصیفی و معنی‌دار

از نام‌گذاری متغیرها با حروف تک‌کاراکتری مانند $a، $b یا مخفف‌های نامفهوم خودداری کنید، مگر در حلقه‌های تکرار بسیار ساده (مانند $i برای شمارنده).

// روش صحیح
$databaseConnection = mysqli_connect(...);

// روش نادرست
$dbConn = mysqli_connect(...);
$c = mysqli_connect(...);

۳. نام‌گذاری متغیرهای بولین (Boolean)

متغیرهایی که مقدار منطقی (true/false) را ذخیره می‌کنند، باید نشان‌دهنده یک وضعیت یا سوال باشند. گوگل استفاده از پیشوندهایی مانند is، has، should یا can را برای این نوع متغیرها پیشنهاد می‌کند.

$hasAccess = false;
$isVerified = true;
$shouldRedirect = false;

قوانین نام‌گذاری ثابت‌ها (Constants)

برخلاف متغیرهای معمولی، ثابت‌ها در PHP باید کاملاً با حروف بزرگ انگلیسی و با جداکننده خط تیره (_) نوشته شوند (فناوری UPPER_SNAKE_CASE).

// تعریف ثابت در کلاس
class Configuration {
    const API_VERSION = 'v2.1';
    const MAX_LOGIN_ATTEMPTS = 5;
}

نام‌گذاری کلاس‌ها و متدها

برای تکمیل استاندارد گوگل در ساختار کدهایتان، حتماً اصول زیر را برای کلاس‌ها و متدها رعایت کنید:

• کلاس‌ها (Classes): باید به صورت PascalCase (کلمه اول نیز با حرف بزرگ شروع می‌شود) نام‌گذاری شوند. مانند: class OrderManager
• متدها (Methods): دقیقاً مانند متغیرها باید به صورت camelCase نوشته شوند. مانند: public function getActiveUsers()

نتیجه‌گیری

رعایت استانداردهای نام‌گذاری گوگل در PHP، نه تنها کیفیت فنی پروژه شما را افزایش می‌دهد، بلکه فرآیند بازبینی کد (Code Review) را در تیم‌های نرم‌افزاری تسهیل می‌کند. همیشه تلاش کنید حتی در پروژه‌های شخصی کوچک نیز از متدولوژی camelCase برای متغیرها و PascalCase برای کلاس‌ها استفاده کنید تا ذهن شما به نوشتن کدهای استاندارد عادت کند.

پیشنمایش